Comparação de Páginas

Tópicos:

Índice

1- URL base API

Ambientes	URL
Desenvolvimento	https://exemplo.tapcore.com.br/
Homologação	https://exemplo.tapcore.com.br/
Produção	https://exemplo.tapcore.com.br/

2- Exemplo endpoints

Endpoint

Método

Descriçã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

Endpoint	Método	Descrição
v4/post_grupo	POST	Descrição do método POST.

Endpoint	Método	Descrição
v4/post_grupo	PUT	Descrição do método PUT.

Endpoint	Método	Descrição
v4/post_grupo	PATCH	Descrição do método PATCH.

Endpoint	Método	Descrição
v4/post_grupo	DELETE	Descrição do método DELETE.

3- Parâmetros query string

Parâmetro

Obrigatório

Tipo

Descrição

id_operadora

true

Cor do plano de fundo

color	#EDEEF1

Inteiro

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

mshash

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

language	js	theme	Midnight
title	Retorno API falha
linenumbers	true

{
    "error": "Erro: Cliente não encontrado.",
    "code": 0,
    "status": 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- Exemplo endpoints

3- Parâmetros query string

4- Exemplo de retorno API (Sucesso)

5- Exemplo de retorno API (Erro)