Nossas APIs são baseadas no protocolo HTTP E possui URLs previsíveis, é orientada a recursos e utiliza códigos de resposta HTTP para indicar sucesso ou erros e exceções.

As respostas (incluindo os erros) e o corpo das requisições são obrigatoriamente formatados em JSON.

Sobre as requisições à API

Os seguintes verbos HTTP estão disponíveis para uso:

Cabeçalho das requisições

O cabeçalho de requisição HTTP usado é:

** Deve-se especificá-los no header das requisições à API.

Autenticação/Autorização

Utilizamos o Apache Shiro para identificar se a solicitação de acesso a API está autenticada, portanto apenas passar No Auth no Type Auth.

Erros & Respostas

Utilizamos os códigos de resposta HTTP convencionais para indicar sucesso ou falha em uma solicitação à API.

• Respostas de informação (100-199),
• Respostas de sucesso (200-299),
• Redirecionamentos (300-399)
• Erros do cliente (400-499)
• Erros do servidor (500-599).

URI Parameters

Alguns recursos disponibilizados podem oferecer a possibilidade de utilização de “URI Parameters” amigáveis.
Os parâmetros quando disponíveis são:

• filter - Habilita filtragem (consulta) de resultados.