1- URL base API
Ambientes | URL |
---|---|
Produção | |
Homologação |
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
Key | Obrigatório | Tipo | Descrição |
---|---|---|---|
| TRUE | string | Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo. |
| FALSE | inteiro | Código de integração da operadora na Mobile Saúde |
| FALSE | string | Nome da operadora para ser exibido para os médicos |
Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:
|
4- Parâmetros envio
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
| TRUE | string
| Data do agendamento “0000-00-00“ |
| TRUE | string
| ID da especialidade do médico |
| TRUE | string | Nome da especialidade do médico |
| TRUE | string | Hora do atendimento “00:00“ |
| TRUE | string | ID da agenda |
| TRUE | string | Login do usuário no app |
| TRUE | string | Localizador mensageria. Este campo deve coincidir com o localizador de mensageria retornado pela sua API de login |
| TRUE | string | CPF do paciente |
| FALSE | string | Email do paciente |
| TRUE | string | Matrícula do paciente |
| TRUE | string | Nome do paciente |
| FALSE | string | Celular do paciente |
| TRUE | string | ID do profissional. Este campo deve coincidir com o campo |
| TRUE | string | Nome do profissional |
| TRUE | string | NR do conselho do profissional |
| TRUE | string | Sigla do conselho do profissional |
| TRUE | string | UF do conselho do profissional |
| FALSE | array | Array de objetos contendo chave e valor dos campos personalizados. Este campos serão exibidos no emails de lembretes de agenda. |
| 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).
{ "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": "0000000000", "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)
{ "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)
{ "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." } |