Introdução

Princípios básicos

Bem-vindo ao guia de referências da Marlim & Foxbit Crypto API! 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:

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.

Ambientes

Para fazer transações com Marlim você tem acesso a duas chaves de API diferentes e dois ambientes diferentes: Sandbox e Produção. Desta forma, é possível diferenciar o ambiente escolhendo a api_key e o endpoint base apropriados para o tipo de operação que você deseja realizar, seguindo as orientações abaixo:

Sandbox

https://sandbox.api.crypto.foxbit.marlim.co

Produção

https://api.crypto.foxbit.marlim.co

warning

As chaves de autenticação para o ambiente de produção têm o poder de realizar qualquer operação em nossa API, por isso é extremamente importante que você as guarde em um local seguro, e que não as exponha no cliente-side do seu aplicativo.

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.

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