Comparação de Páginas

Tópicos:

Índice

1- URL base API

Ambientes

Ambiente	URL

Desenvolvimento

Produção

https://

exemplo

admin.

tapcore.com.br/Homologaçãohttps://exemplo.tapcore.com.br/Produçãohttps://exemplo.tapcore.com.br/

2- Exemplo endpointsEndpointMétodoDescrição

v4/get_menu_grupo

GET

Descrição do método GET. Exemplo: Método que lista os grupos de menus do cliente.

Nota

title	ATENÇÃO:

Exemplo de observação

EndpointMétodoDescrição

v4/post_grupo

POST

Descrição do método POST.

EndpointMétodoDescrição

v4/post_grupo

PUT

Descrição do método PUT.

EndpointMétodoDescrição

v4/post_grupo

PATCH

Descrição do método PATCH.

EndpointMétodoDescrição

v4/post_grupo

DELETE

Descrição do método DELETE.

3- Parâmetros query string

ParâmetroObrigatórioTipoDescriçãoid_operadora

mosia.chat/api/

2- Endpoint

Endpoint	Método	Descrição
Atendente/novo	POST	Cria um novo atendente/médico do Mosia.

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.

Image Added

4- Parâmetros envio

4.1 Nó "usuario":

Parâmetro

Obrigatório

Tipo

Descrição

nome

true

Cor do plano de fundo

color	#EDEEF1

String

Nome do atendente.

email

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Email do atendente.

login

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Login do atendente.

senha

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Senha do atendente.

telefone

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Telefone do atendente com prefixo, exemplo: 27999999999

id_perfil

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Perfil do usuário.

1 - Atendente

2 - Supervisor

cpf

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1

String

CPF do atendente, apenas números.

data_nasc

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Data de nascimento do atendente no formato dd/mm/aaaa.

sexo

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Sexo do atendente.

F - Feminino

M - Masculino

atendimentos_simultaneos

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Id da operadora para a qual serão buscados os grupos de menu

mshash

trueNúmero de atendimentos simultâneos que este atendente realiza.

Na telemedicina torna-se obrigatório apenas 1 atendimento simultâneo.

visualiza_historico_chamador

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Inteiro

HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

4- Exemplo de retorno API (Sucesso)

Bloco de código

language	js
theme	Midnight
title	Retorno API sucesso
linenumbers	true

[
    {
        "id_cms_menu_site_grupo": 34,
        "nome": "Área do Beneficiário",
        "chave": "area-do-beneficiario",
        "base_url_producao": "http://localhost:8080/#/",
        "base_url_homologacao": "http://localhost:8080/#/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 1
    },
    {
        "id_cms_menu_site_grupo": 35,
        "nome": "Área do Conveniado",
        "chave": "area-do-conveniado",
        "base_url_producao": "http://localhost:8080/#/",
        "base_url_homologacao": "http://localhost:8080/#/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 1
    },
    {
        "id_cms_menu_site_grupo": 33,
        "nome": "Menu do Rodapé",
        "chave": "menu-do-rodape",
        "base_url_producao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
        "base_url_homologacao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 2
    },
    {
        "id_cms_menu_site_grupo": 31,
        "nome": "Menu do Topo",
        "chave": "menu-do-topo",
        "base_url_producao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
        "base_url_homologacao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 3
    },
    {
        "id_cms_menu_site_grupo": 36,
        "nome": "Menu Topo Botões",
        "chave": "menu-topo-botoes",
        "base_url_producao": "http://localhost:8080/#/",
        "base_url_homologacao": "http://localhost:8080/#/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 2
    }
]

5- Exemplo de retorno API (Erro)

Bloco de códigolanguagejsthemeMidnight

Parâmetro que permite o atendente visualizar no histórico de chamados dos atendimentos apenas dele ou todos os atendimentos realizados.

0 - Desativado

1 - Ativado

codigo_integracao_crm

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Código de integração CRM do atendente.

Na telemedicina este é o campo responsável por referenciar o médico e obter a lista de agendamentos.

4.2 Nó "filas":

Parâmetro

Obrigatório

Tipo

Descrição

fila_atendimento_padrao

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

int

ID da fila de atendimento padrão. Obrigatório caso seja passado o parâmetro filas_atendimento.

Caso fila_atendimento_padrao e filas_atendimento não sejam passados, uma fila será criada automaticamente para este atendente.

filas_atendimento

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

Array(Inteiro)

IDs das filas que o atendente pode atender. Obrigatório caso seja passado o parâmetro fila_atendimento_padrao.

Caso fila_atendimento_padrao e filas_atendimento não sejam passados, uma fila será criada automaticamente para este atendente e adicionada ao array filas_atendimento.

4.3 Nó "telemedicina":

Parâmetro

Obrigatório

Tipo

Descrição

numero_conselho

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Número do conselho do médico.

sigla_conselho

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Sigla do conselho do médico.

uf_conselho

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

UF do conselho que do médico.

id_especialidade

Condicional (Obrigatório na telemedicina)

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

CBO da especialidade.

Exemplo: O código 225120 se refere a especialidade "Cardiologista".

id_prontuario_modelo

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

ID do modelo de prontuário que será utilizado.

Caso seja utilizado é possível obter o ID no painel admin do Mosia, http://admin.mosia.chat/.

Acessar o Menu Telecare > Modelos de Prontuário > Clicar em editar o item desejado. Nesta página será o último item do link, exemplo: ....modelosProntuario/editar/22.

tempo_duracao_agenda

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Estimativa de tempo de duração de uma consulta em minutos. Caso não seja informado o tempo padrão passado será de 20 minutos. Obs: item apenas informativo.

visualiza_resumo_prontuario_geral

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Permite o médico visualizar o resumo de prontuário completo do paciente. Atendimentos realizados por ele e/ou outros médicos na plataforma.

0 - Desativado

1 - Ativado

visualiza_resumo_prontuario_no_historico

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Permite o médico visualizar o resumo do prontuário do paciente no histórico de chamados.

0 - Desativado

1 - Ativado

habilita_encaminhamento

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

Inteiro

Parâmetro que permite o médico gerar encaminhamento. ...

0 - Desativado

1 - Ativado

5- Body request (JSON).

Bloco de código

language	js
title	Exemplo body
linenumbers	true

{
  "usuario": {
    "nome": "User Teste 8",
    "email": "userteste@gmail.com",
    "login": "userteste8",
    "senha": "123456",
    "telefone": "(27) 99999-9999",
    "id_perfil": 2,
    "cpf": "12345678910",
    "data_nasc": "31/01/1996",
    "sexo": "M",
    "atendimentos_simultaneos": 1,
    "visualiza_historico_chamador": 1,
    "codigo_integracao_crm": "123"
  },
  "filas": {
    "filas_atendimento": [],
    "fila_atendimento_padrao": null
  },
  "telemedicina": {
    "numero_conselho": "111999",
    "sigla_conselho": "CRM",
    "uf_conselho": "ES",
    "id_especialidade": "221105",
    "id_prontuario_modelo": 22,
    "tempo_duracao_agenda": 30,
    "visualiza_resumo_prontuario_geral": 0,
    "visualiza_resumo_prontuario_no_historico": 0,
    "habilita_encaminhamento": 0
  }
}

5- Retorno com sucesso (200)

Bloco de código

language	js
title	Retorno API sucesso
linenumbers	true

{
  "status": true,
  "data": [],
  "critica": [
    null
  ],
  "timestamp": "2021-05-07T17:47:47-03:00",
  "msg": "Usuário criado com sucesso."
}

6- Retorno com erro (200)

Bloco de código

language	js
title	Retorno API falha
linenumbers	true

{
  "status": false,
  "errordata": "Erro: Cliente não encontrado.",
 [],
  "critica": [
    null
  ],
  "codetimestamp": 0"2021-05-07T17:47:47-03:00",
    "statusmsg": false
}

Nota

title	ATENÇÃO

Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro.Padrões documentação API

 "Falha na autenticação."
}

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

1- URL base API

2- Endpoint

3- Autenticação

Image Added

4- Parâmetros envio

4.1 Nó "usuario":

5- Exemplo de retorno API (Erro)

4.2 Nó "filas":

4.3 Nó "telemedicina":

5- Body request (JSON).

5- Retorno com sucesso (200)

6- Retorno com erro (200)