Documentação da API

Clique aqui para acessar a documentação web da API.

Autenticação da API

Download Postman Collection

Clique aqui para baixar a collection da API (swagger.json).

Para acessar os endpoints protegidos da API, siga o fluxo de autenticação abaixo:

1. Gerar um Token de Acesso

Você deve realizar uma requisição ao endpoint /authorization para gerar o token de autenticação. Esse token será utilizado para validar suas requisições futuras.

Endpoint: POST /authorization

Retorno esperado:

        {
        "token": "seu_token_aqui"
        }

2. Usar o Token no Header das Requisições

Após obter o token de acesso, inclua-o no header das requisições aos endpoints protegidos:

Chave do Header: Authorization
Formato do Valor: Bearer <seu_token_aqui>

Exemplo de Header:

Authorization: Bearer seu_token_aqui

3. Validação do Token

A API verificará o token enviado. Caso o token seja inválido, expirado ou ausente, a requisição será rejeitada com o código de status HTTP 403 Forbidden.

4. Exemplo de Requisição Protegida

        curl -X GET "https://sua-api.com/protected-route"         -H "Authorization: Bearer seu_token_aqui"

Certifique-se de manter o token seguro e renová-lo conforme necessário.