API de Agenda

Visão Geral:

A API de Agenda permite o gerenciamento de agendamentos de forma eficiente e integrada. Com esta API, é possível realizar operações relacionadas aos agendamentos, facilitando a interação entre sistemas e usuários.

Funcionalidades Principais:

Gerenciar Agendamentos: Criar, consultar, atualizar e cancelar agendamentos.
Consulta de Disponibilidade: Verificar a disponibilidade de horários para agendamentos.

Endpoints Disponíveis:

A API fornece diversos endpoints, incluindo, mas não se limitando a:

Lista todos os agendamentos.
Cria um novo agendamento.
Retorna detalhes de um agendamento específico.
Atualiza um agendamento existente.
Cancela um agendamento.

Formato de Resposta:

As respostas da API são retornadas em formato JSON, contendo informações detalhadas sobre os agendamentos, como:

{
  "Sucesso": true,
  "IdMarcacao": 0,
  "IDConferencia": "string",
  "URIConferencia": "string",
  "Glosas": [
    {
      "Codigo": "string",
      "Mensagem": "string"
    }
  ]
}

Autenticação e Segurança:

A API utiliza o método de autenticação baseado em Access Token para garantir que apenas usuários autorizados possam acessar e manipular os dados dos agendamentos. Detalhes sobre o método de autenticação podem ser encontrados na documentação.

Erros Comuns:
A API pode retornar erros padrão, como:

400 Bad Request: Para requisições malformadas.
401 Unauthorized: Quando a autenticação falha.

Conclusão

A API de Agenda oferece um conjunto robusto de funcionalidades para o gerenciamento de agendamentos, possibilitando uma integração eficiente com sistemas de saúde e melhorando a experiência do usuário. Para mais detalhes, consulte a documentação completa disponível no Swagger UI.

Swagger ambiente de TRN (treinamento):

https://trn-agenda.pepunimed.com.br/swagger/ui/index#/Agenda

Swagger ambiente de HML (homologação):

https://hml-agenda.pepunimed.com.br/swagger/ui/index#/Agenda