Introdução

Considerações:

A API da Flixlog, segue o padrão REST, tendo como métodos de ação os verbos HTTP.

O negociação de conteúdo é feita por meio de JSON, quando há a necessidade de enviar um arquivo, como por exemplo o XML da Nota Fiscal, é necessário que o arquivo seja enviado de forma codificada em base64, para que seja recebido de forma correta.

As requisições são atômicas, não há estado inconsistente se for retornado 200, 201 e 204. Os status code de erro e sucesso seguem o padrão da RFC2616:

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Os mais utilizados serão:

Sucesso:

• 200 - OK, utilizado nos métodos de listagem e busca. Tem exemplos de retorno no link da documentação.

• 201 - Quando um recurso for criado com sucesso. O retorno será sempre uma entidade com os dados criados e o identificador para consulta posterior.

• 202 - Quando uma requisição for aceita, mas o processamento será feito em segundo plano. Não virá nada no corpo da requisição.

• 204 - Atualização ou Exclusão realizada com sucesso. Não virá nada no corpo da requisição.

Erros:

• 400 - Verificar se json está em um formato válido.

• 404 - Entidade não encontrada.

• 405 - O recurso solicitado não permite esse método.

• 409 - Quando já tiver sido inserido um registro e for requisitado novamente a inserção (Duplicidade).

• 422 - A validação retornou algum erro, verificar documentação para analisar se os dados estão corretos.

• 429 - Foi excedido o limite de requisições por minuto para esse recurso.

Endpoints:

Cotação de Frete: https://freight.flixlog.com/quotation

Demais APIs: https://api-v2.flixlog.com

Divirta-se!