Introdução

Requisitos

Autenticação

A API do Fretefy usa ApiKey para autenticar as requisições.

A sua ApiKey possui muitos privilégios; portanto, mantenha-a protegida! Não compartilhe ApiKey em áreas publicamente acessíveis, como GitHub, código do cliente e assim por diante.

A autenticação para a API é realizada via HTTP Basic Auth. Forneça sua chave de API como o valor básico do nome de usuário de autenticação. Você não precisa fornecer uma senha.

Todas as requisições devem ser feitas por HTTPS. As chamadas feitas sobre HTTP simples falharão. Todas as requisições devem conter o header Authorization: ApiKey{apikey}, caso contrário falharão.

Solicitando sua ApiKey

A solicitação da ApiKey é feita através do e-mail [email protected]

Formatos e retorno

Formatos

Tipo	Descrição	Padrão	Exemplo
date	Data	Devem estar no formato ISO 8601 conforme padrão estabelecido no JSON. As datas devem obrigatoriamente estar no timezone UTC.	2012-03-19T07:22:00.000Z
number	Número	Devem ser informados sem separadores de milhar e com o ponto para separador de decimal	1500.00

Códigos de retorno

Código	Descrição
200	Indica sucesso podendo ou não ter um conteúdo retornado, sempre em JSON.
400	Erro de validação. Os detalhes são retornados no corpo da resposta.
401	Falha de autenticação, sendo necessária a verificação da ApiKey.
404	O recurso solicitado não existe.
405	Método não permitido