Introdução

Princípios básicos

Bem-vindo ao guia de referências da API da Marlim! Nossa API é RESTful e é através dela que você integra o seu sistema ao nosso.

As chamadas a nossa API utilizam os verbos comuns REST e todas as respostas retornam em formato JSON, no endpoint base:

https://api.marlim.co

Importante

Nossa API não aceita em nenhum endpoint valores null, undefined ou string vazia. Caso você passe um parâmetro com algum desses 3 valores, irá retornar um erro. Se o parâmetro não for obrigatório e você não quiser que ele seja computado, basta remover da request.

Autenticação

Sempre que a sua aplicação chama algum de nossos endpoints, você deve passar como forma de autenticação a sua API Key adicionada ao Header da requisição, utilizando o seguinte formato:

"api_key": "sua_api_key_value"

Nota

Sua chave de api deve ser requisitada ao nosso time de Atendimento ou Desenvolvimento.

Ambientes de teste e produção

Você tem acesso a duas Chaves de API distintas, uma para teste e outra para produção. Dessa forma, o endpoint é o mesmo, sendo possível diferenciar o ambiente apenas escolhendo a chave apropriada para o tipo de operação que você deseja fazer.

Cuidado

As chaves de autenticação para o ambiente live tem o poder de executar qualquer operação em nossa API, então é extremamente importante que você as mantenha em local seguro, e que não exponha no client-side de sua aplicação.

Códigos de resposta

Nossa API usa como retorno os códigos HTTP padrão para indicar tanto o sucesso de uma requisição, quanto para indicar falha. Segue:

Código	Significado
200	Tudo ocorreu como deveria e sua requisição foi processada com sucesso.
400	Algum parâmetro obrigatório não foi passado, ou os parâmetros passados não estão corretos.
401	Falta de autorização para acessar este endpoint.
403	O valor passado no parâmetro está incorreto.
404	Endpoint ou algum valor não encontrado.
405	Método não autorizado.
408	Timeout de 60s atingido.
500	Erro interno da API, tente novamente. Caso continue, entre em contato conosco.

Versão

A versão mais atual da API se encontra em: v2