Comparação de Páginas

Tópicos:

Índice

1- URL base API

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

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.

hora

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Hora do agendamento no formato "HH:mm".

idAgenda

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

ID do agendamento.

localizadorMensageria

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Identificador único do paciente.

pacienteCpf

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Cpf do paciente.

pacienteEmail

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

E-mail do paciente.

pacienteMatricula

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Matrícula do paciente.

pacienteNome

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Nome do paciente.

profissionalNome

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Nome do médico.

profissionalNumeroConselho

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Número do conselho do médico.

profissionalSiglaConselho

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Sigla do conselho do médico.

profissionalUfConselho

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

UF do conselho do médico.

telefoneCelular

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Celular do paciente.

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",
  "localizadorMensageria": "100100500",
  "pacienteCpf": "99999999999",
  "pacienteEmail": "paciente@email.com.br",
  "pacienteMatricula": "100100500",
  "pacienteNome": "João dos Santos",
  "profissionalNome": "Luiz Fernando",
  "profissionalNumeroConselho": "11100",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES",
  "telefoneCelular": "27999999999"
}

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 3

Nova versão 4

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)