Começando

Entre em contato com a nossa equipe de relacionamento a traves do nosso email para obter mais informações sobre a nossa API e solicitar accesso.

Gerando as chaves

Após obter accesso, acesse o menu "API" e em seguida clique no botão "Gerar chave".

Pronto, uma chave de API foi gerada, e nela contêm duas informações:

Chave	Descrição
api	Hash de 10 dígitos referente a identificação da chave.
secret	Hash de 32 dígitos referente a sua chave privada.

Você irá utilizar essas chaves no HEADER das requisições para a nossa API.

Atencão

Certifique de copiar e guarda a chave secret, pois após a criação você não terá mais acesso a mesma na plataformas. O rate limit dos nossos end-points é de 100reqs/sec API.

Configurando sua requisição

Você pode testar usando o Postman, Insominia ou outra aplicação similar de sua preferência para realizar os testes de integração a nossa API.

Com posse das chaves, será necessário configurar os headers da aplicação, da seguinte forma:

headers: {
    api: <SUA_API>
    secret: <SUA_API_SECRET>
}

Observação

Nem todos os endpoints da nossa API precisam da referencia da chave de api/secret nos headers, você pode conferir a necessidade dos mesmos através do nosso Swagger.