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/register	POST	Método para inserir uma nova 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

nome_operadora

Estado

colour	Red
title	FALSE

string

Nome da operadora para ser exibido para os médicos

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

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. Este campo deve coincidir com a chaveUnica do beneficiário retornada pela sua API de login, e também deve coincidir com a chaveUnica retornada na API de agenda médica

Login do usuário no app

localizadorMensageria

Estado

colour	Green
title	TRUE

string

Localizador mensageria. Este campo deve coincidir com o localizador de mensageria retornado pela sua API de login

pacienteCpf

Estado

colour	Green
title	TRUE

string

CPF do paciente

pacienteEmail

Estado

colour

Green

title
Red

TRUE

FALSE

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
Red

TRUE

FALSE

string

Celular do paciente

idChaveUnicaProfissional

Estado

colour	Green
title	TRUE

string

ID do profissional. Este campo deve coincidir com o campo
chaveUnica do objeto “profissional” do retorno da API de agenda médica

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

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 lembretes de agenda.

atendimentoSimplificado

Estado

colour	Red
title	FALSE

boolean

Indica que o agendamento será de forma simplificada. Com este modo ativado, não será possível o uso da vídeo chamada, o médico vai iniciar o chamado no Mosia (sem vídeo) para utilizar os recursos como prontuário, prescrições, registro de atendimento, entre outros recursos.

O paciente neste caso não tem a necessidade de ter um login/app instalado.

O contato do médico com o paciente seria por telefone.

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": "058693107410000000000",
  "pacienteEmail": "joao_t@mobilesaude.com.br", // NÃO OBRIGATÓRIO
  "pacienteMatricula": "10001010101",
  "pacienteNome": "João T.",
  "pacienteCelular": "2799999999", // NÃO OBRIGATÓRIO
  "idChaveUnicaProfissional" : "208",
  "profissionalNome": João T.",
  "profissionalNumeroConselho": "10020",
  "profissionalSiglaConselho": "CRM",
  "profissionalUfConselho": "ES",
  "camposPersonalizados": [           // NÃO OBRIGATÓRIO
      {
          "chave": "Teste",
          "valor": "Valor teste"
      },
      {
          "chave": "Teste 2",
          "valor": "Valor teste 2"
      }
  ],
  "atendimentoSimplificado": false    // NÃO OBRIGATÓRIO
}

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 5

Nova versão Atual

Chave

1- URL base API

2- Endpoint

3-

Headers

4- Parâmetros envio

5- Body request (JSON).

6- Retorno com sucesso (200)

7- Retorno com erro (200)