Comparação de Páginas

Tópicos:

Índice

1- URL base API

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_operadoraDesenvolvimentoexemplotapcore.com.br/

Ambientes	URL
Produção	https://	api.
Homologação	https://exemplo.tapcore.com.br/
Produção	https://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

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 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

mshash

Cor do plano de fundo

id
color	#EDEEF1

Inteiro

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

tipo

String

UF do conselho do médico.

telefoneCelular

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

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

4- Exemplo

de retorno API (Sucesso)

do request body

Bloco de código

language	js
theme	Midnight
title	Retorno API sucesso
linenumbers	true
collapse	true

[
    {
        "id_cms_menu_site_grupo": 34,
        "nome": "Área do Beneficiário",
        "chave": "area-do-beneficiario",
        "base_url_producao": "http://localhost:8080/#/"data": "2020-06-05",
  "especialidadeNome": "Cardiologia",
        "base_url_homologacao"hora": "http://localhost:8080/#/09:40",
        "base_url_dev"idAgenda": "http://localhost:8080/#/10020",
     
  "id_operadoralocalizadorMensageria": 165,
        "id_aplicacao": 7100100500",
        "qtd_niveis"pacienteCpf": 1
    },
    {
        "id_cms_menu_site_grupo": 35,
    "99999999999",
   "nomepacienteEmail": "Á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/paciente@email.com.br",
        "base_url_homologacao"pacienteMatricula": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/100100500",
        "base_url_dev"pacienteNome": "http://localhost:8080/#/",
        "id_operadora": 165João dos Santos",
        "id_aplicacao"profissionalNome": 7,         "qtd_niveis": 2
    },
    {
        "id_cms_menu_site_grupo": 31,
        "nome": "Menu do Topo",
        "chave": "menu-do-topo"Luiz Fernando",
  "profissionalNumeroConselho": "11100",
  "profissionalSiglaConselho": "CRM",
        "base_url_producao"profissionalUfConselho": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
     ES",
  "base_url_homologacaotelefoneCelular": "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
    }
]27999999999"
}

4- Exemplo de retorno API (Sucesso)

Bloco de código

language	js
theme	Midnight
title	Retorno API sucesso
linenumbers	true
collapse	true

{
    "status": true,
    "message": "<MENSAGEM>"
}

5- Exemplo de retorno API (Erro)

Bloco de código

language	js
theme	Midnight
title	Retorno API falha
linenumbers	true
collapse	true

{
      "errorstatus": "Erro: Cliente não encontrado."false,
      "codemessage": 0,
    "status<MENSAGEM>": 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

Versões comparadas

Versão antiga 1

Nova versão 2

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)