Documentação da API do aplicativo C-Level
A API permitirá que sistemas consumam dados a respeito dos indicadores consolidados no dashboard.
Base URL: https://clevelapi.sanasa.com.br
Funcionalidades:
- /indicadores = retorna os indicadores consolidados no dashboard
- /indicadores/refresh = força a atualização dos indicadores consolidados
Autenticação #
A autenticação da API é realizada utilizando um Token Bearer. Para usar a API, você precisa obter um token de acesso, que deve ser incluído nos cabeçalhos das requisições.
.
Como obter o token: #
- Realize o login com suas credenciais no sistema.
- Solicite o token via POST na URL /auth/login.
.
Cabeçalho de Autenticação: #
Authorization: Bearer {token_de_acesso}
.
Endpoints #
Indicadores #
- URL: /indicadores
- Método: GET
- Descrição: retorna os indicadores consolidados no dashboard
Exemplo de Requisição:
GET /tasks
Authorization: Bearer {token_de_acesso}
Resposta (200 OK):
Resposta (401 Unauthorized):
Resposta (404 Not Found):
Refresh #
- URL: /indicadores/refresh
- Método: POST
- Descrição: força a atualização dos indicadores consolidados
Exemplo de Requisição:
curl -X ‘POST’ \
‘https://clevelapi.sanasa.com.br/Indicadores/refresh’ \
-H ‘accept: */*’ \
-d ”
Resposta (200 OK):
.
Resposta (401 Unauthorized):
.
Resposta (404 Not Found):
Schemas #
