Comparação de Páginas

Tópicos:

Índice

1- URL base API

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

2- Endpoint

Endpoint	Método	Descrição
videocall/prepare/register	POST	Método para iniciar um processo de preparo do Telecare

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.

3- Request Body (JSON)

Parâmetro

Obrigatório

Tipo

Descrição

data

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Data do agendamento no formato "AAAA-MM-DD".

especialidadeNome

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Nome da especialidade do médico

.

horatrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Hora do agendamento no formato "HH:mm". Se o intervalo entre data/hora atual e a data/hora da agenda for menor que prazo para o envio da ultima notificação, o pedido de preparo não será acatado. Neste caso, o paciente será recepcionado da forma tradicional, informando um numero de documento no ato da chamada do médico.

especialidadeNome

true

Nome da especialidade do médico.

idAgendatrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

ID do agendamento.identificadorUnicotrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Identificador único do pacientepacienteCpftrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Cpf do paciente.pacienteEmailtrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

E-mail do paciente.pacienteMatriculatrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Matrícula do paciente.pacienteNometrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Nome do paciente.telefoneCelulartrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Celular do paciente.profissionalNometrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Nome do médico.profissionalNumeroConselhotrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Número do conselho do médico.profissionalSiglaConselhotrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Sigla do conselho do médico.profissionalUfConselhotrue

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

UF do conselho do médico.telefoneCelularprofissionalIdExternotruefalse

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Celular ID externo do paciente.médico

4- Exemplo do request body

Bloco de código

language	js
title	Retorno API sucesso
linenumbers	true

{
  "data": "2020-06-05",
  "especialidadeNome": "Cardiologia",
  "hora": "09:40",
  "idAgenda": "10020",
  "localizadorMensageriaidentificadorUnico": "100100500",
  "pacienteCpf": "99999999999",
  "pacienteEmail": "paciente@email.com.br",
  "pacienteMatricula": "100100500",
  "pacienteNome": "João dos Santos",
  "telefoneCelular": "27999999999",
  "profissionalNome": "Luiz Fernando",
  "profissionalNumeroConselho": "11100",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES",
  "telefoneCelularprofissionalIdExterno": "27999999999123"
}

4- Exemplo de retorno API (Sucesso)

Bloco de código

language	js
title	Retorno API sucesso
linenumbers	true

{
    "status": true,
    "message": "<MENSAGEM>"
}

5- Exemplo de retorno API (Erro)

Bloco de código

language	js
title	Retorno API falha
linenumbers	true

{
    "status": false,
    "message": "<MENSAGEM>"
}

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

1- URL base API

2- Endpoint

3- Autenticação

3- Request Body (JSON)

4- Exemplo do request body

4- Exemplo de retorno API (Sucesso)

5- Exemplo de retorno API (Erro)