Comparação de Páginas

1- URL base API

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

2- Endpoint

Endpoint	Método	Descrição
schedule/register	POST	Método para inserir uma nova 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 Added

4- Parâmetros envio

Parâmetro

Obrigatório

Tipo

Descrição

data

Estado

colour	Green
title	TRUE

string

Data do agendamento “0000-00-00“

especialidadeId

Estado

colour	Green
title	TRUE

string

ID da especialidade do médico

especialidadeNome

Estado

colour	Green
title	TRUE

string

Nome da especialidade do médico

hora

Estado

colour	Green
title	TRUE

string

Hora do atendimento “00:00“

idAgenda

Estado

colour	Green
title	TRUE

string

ID da agenda

idChaveUnicaPaciente

Estado

colour	Green
title	TRUE

string

Chave única do paciente. Campo utilizado para login no app

localizadorMensageria

Estado

colour	Green
title	TRUE

string

Localizador mensageria

pacienteCpf

Estado

colour	Green
title	TRUE

string

CPF do paciente

pacienteEmail

Estado

colour	Green
title	TRUE

string

Email do paciente

pacienteMatricula

Estado

colour	Green
title	TRUE

string

Matrícula do paciente

pacienteNome

Estado

colour	Green
title	TRUE

string

Nome do paciente

pacienteCelular

Estado

colour	Green
title	TRUE

string

Celular do paciente

idChaveUnicaProfissional

Estado

colour	Green
title	TRUE

string

ID do profissional

profissionalNome

Estado

colour	Green
title	TRUE

string

Nome do profissional

profissionalNumeroConselho

Estado

colour	Green
title	TRUE

string

NR do conselho do profissional

profissionalSiglaConselho

Estado

colour	Green
title	TRUE

string

Sigla do conselho do profissional

profissionalUfConselho

Estado

colour	Green
title	TRUE

string

UF do conselho do profissional

5- Body request (JSON).

Bloco de código

{
  "data": "2021-01-26",
  "especialidadeId": "01",
  "especialidadeNome": "Cardiologia",
  "hora": "08:20",
  "idAgenda": "R551",
  "idChaveUnicaPaciente": "joao_t@mobilesaude.com.br",
  "localizadorMensageria" : "joao_t@mobilesaude.com.br",
  "pacienteCpf": "05869310741",
  "pacienteEmail": "joao_t@mobilesaude.com.br",
  "pacienteMatricula": "10001010101",
  "pacienteNome": "João T.",
  "pacienteCelular": "2799999999",
  "idChaveUnicaProfissional" : "208",
  "profissionalNome": João T.",
  "profissionalNumeroConselho": "10020",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES"
}

6- Retorno com sucesso (200)

Bloco de código

{
    "status": true,
    "data": {
        "id": "00677dd7-7191-4793-8854-ae00320ef960",
        "url": "portal.mosia.com.br/teleconsulta?sala=00677dd7-7191-4793..."
    },
    "critical": null,
    "timestamp": "2021-01-19T15:10:10.074Z",
    "msg": "Agenda criada com sucesso."
}

7- Retorno com erro (200)

Bloco de código

{
    "status": false,
    "data": {},
    "critical": [
        {
            "COD": 0,
            "DESC": "Agenda já se encontra registrada.",
            "origem": "schedule/register",
            "trace": "",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2021-01-19T15:11:41.975Z",
    "msg": "Agenda já se encontra registrada."
}

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

1- URL base API

2- Endpoint

3- Autenticação

4- Parâmetros envio

5- Body request (JSON).

6- Retorno com sucesso (200)

7- Retorno com erro (200)