Bem-vindo ao guia de referências da API da Marlim.co! Nossa API é RESTful e é através dela que você integra o seu sistema ao nosso.
\n\nSe você tiver alguma sugestão, reclamação ou dúvida sobre qualquer procedimento, por favor entre em contato conosco. Estamos em constante aprimoramento e te ouvir é muito importante para nós.
\n\nTodas as chamadas a nossa API são utilizando o método POST e todas as respostas retornam em formato JSON, no endpoint base:
\n\n```\n https://api.marlim.co/\n\n ```\n\n###### ⚠️ 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.\n\nSempre 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:
\n\n```\n api_key: sua_api_key_value\n\n ```\n\n###### ⚠️ Sua chave de api deve ser requisitada ao nosso time de Atendimento ou Desenvolvimento.\n\nPara transacionar com a Marlim.co 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.
\n\nNossa API usa como retorno os códigos HTTP padrão para indicar tanto o sucesso de uma requisição, quanto para indicar falha. Segue:
\n\n| 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. |
500 | Erro interno da Marlim.co, tente novamente. Caso continue, entre em contato conosco. |
Todos os erros retornam um objeto ERRORS com duas propriedades: type e message como forma de auxiliar a identificar o possível motivo do erro, como no exemplo abaixo:
À partir de 01/09/2021 entrará no ar a v2 da nossa API. Enquanto que a v1 entrará em depreciação em 01/01/2022, retornando o código 404 (Not Found) nos antigos endpoints.