Versões comparadas

Version Versão antiga 7 Nova versão 8
Alterações feitas por

Rafael Simão Xavier

Rafael Simão Xavier

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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- Autenticação

Key

Value

Descrição

Authorization

<TOKEN_API_MOSIA>

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

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

idAgendaIntegracao

Estado
colourGreen
titleTRUE

string

 

ID da agenda (Sistema do cliente)

idChaveUnicaPaciente

Estado
colourGreen
titleTRUE

string

 

Chave única do paciente

idChaveUnicaProfissional

Estado
colourGreen
titleTRUE

string

ID do médico (Sistema do cliente)

camposPersonalizados

Estado
colourRed
titleFALSE

array

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

operadoraId

Estado
colourRed
titleFALSE

Int

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

5- Body request

Bloco de código
{
  "idAgendaIntegracao": "200",
  "idChaveUnicaPaciente": "paciente@email.com.br",
  "idChaveUnicaProfissional" : "919191",
  "camposPersonalizados": [
      {
          "chave": "Teste cancelamento",
          "valor": "Valor teste cancelamento"
      },
      {
          "chave": "Teste cancelamento 2",
          "valor": "Valor teste cancelamento 2"
      }
  ],
  "operadoraId": null, // NÃO OBRIGATÓRIO
}

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."
}