Comparação de Páginas

1- URL base API

Ambientes	URL
Produção	https://api.mosia.chat/v1
Homologação	https://api.hmg.mosia.chat/v1

2- Endpoint

Endpoint	Método	Descrição
schedule/cancel	POST	Método cancela uma agenda de acordo com os parâmetros de entrada.

3-

...

Headers

Campo

Key

Obrigatório

Value

Tipo	Descrição
`Authorization`

<TOKEN_API_MOSIA>

Estado

colour	Green
title	TRUE

string

Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.

id_operadora

Estado

colour	Red
title	FALSE

inteiro

Código de integração da operadora na Mobile Saúde

Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:

Acesse a administração do MOSIA, em admin.mosia.chat
No menu principal, acesse "Ajustes Gerais" e habilite o CRM;
Indique uma URL de CALLBACK e salve as mudanças.
Um token será exibido. Este é o token que será utilizado nas integrações destas APIs.

Image Modified

4- Parâmetros envio

Parâmetro	Obrigatório	Tipo	Descrição

idAgenda

idAgendaIntegracao

Estado

colour	Green
title	TRUE

string

ID da agenda (Sistema do cliente)

idChaveUnicaPaciente

Estado

colour	Green
title	TRUE

string

Chave única do paciente

profissionalId

idChaveUnicaProfissional

Estado

colour	Green
title	TRUE

string

ID do médico (Sistema do cliente)

camposPersonalizados

Estado

colour	Red
title	FALSE

array

Array de objetos contendo chave e valor dos campos personalizados. Este campos serão exibidos no emails de cancelamento de agenda.

bloquearNotificacao

Estado

colour	Red
title	FALSE

boolean

O valor default é “false”. Quando houver a necessidade de não enviar notificação de cancelamento para o beneficiário, deve ser passado true neste parâmetro.

5- Body request

Bloco de código

language	json

{
  "idAgendaidAgendaIntegracao": "200",
  "idChaveUnicaPaciente": "paciente@email.com.br",
  "profissionalIdidChaveUnicaProfissional" : "919191",
  "camposPersonalizados": [
      {
          "chave": "Teste cancelamento",
          "valor": "Valor teste cancelamento"
      },
      {
          "chave": "Teste cancelamento 2",
          "valor": "Valor teste cancelamento 2"
      }
  ],
  "bloquearNotificacao": false
}

6- Retorno com sucesso (200)

Bloco de código
{ "status": true, "data": {}, "critical": null, "timestamp": "2021-01-19T16:43:56.256Z", "msg": "Agenda cancelada com sucesso." }

7- Retorno com erro (200)

Bloco de código

{
    "status": false,
    "data": {},
    "critical": [
        {
            "COD": 0,
            "DESC": "A propriedade [idAgenda] é obrigatória.",
            "origem": "",
            "trace": "",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2021-01-19T16:44:42.868Z",
    "msg": "A propriedade [idAgenda] é obrigatória."
}

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

1- URL base API

2- Endpoint

3-

Headers

4- Parâmetros envio

5- Body request

6- Retorno com sucesso (200)

7- Retorno com erro (200)