Skip to main content

Contexto

Referência da API

Nosso API segue as melhores práticas de integração para uma API RESTful. Todas as requisições que envolvem dados dos usuários devem ser autenticadas com OAuth2. Tokens fornecidos via autenticação OAuth2 possuem validade de 3 horas e devem ser atualizados mediante a uma nova solicitação de autenticação.

Todas as requisições devem utilizar o protocolo HTTPS.

O cabeçalho HTTP Accept deve ser enviado como: (Accept: application/json) e Content-Type (Content-Type: application/json), com exceção para rotas de autenticação OAuth2.

Todas as respostas seguem o formato JSON com os seus respectivos códigos de status do protocolo HTTP. Payloads para requisições, com exceção do método GET, devem ser realizadas obrigatoriamente no corpo da requisição e codificados como JSON.

Retornos Esperados
Código Status Descrição
200
OK
O recurso solicitado foi processado e retornado com sucesso.
201
Created
O recurso informado foi criado com sucesso.

401

Unauthorized
A chave da API está desativada, incorreta ou não foi informada corretamente. Consulte a seção sobre autenticação da documentação.

403

Forbidden
O acesso ao recurso não foi autorizado. Este erro pode ocorrer por dois motivos: (1) Uma conexão sem criptografia foi iniciada. Neste caso utilize sempre HTTPS. (2) As configurações de perfil de acesso não permitem a ação desejada. Consulte as configurações de acesso no painel de administração.
404
Not Found
O recurso solicitado ou o endpoint não foi encontrado.

406

Not Acceptable
O formato enviado não é aceito. O cabeçalho Content-Type da requisição deve contar obrigatoriamente o valor application/json para requisições do tipo POST e PUT.

422

Unprocessable Entity
A requisição foi recebida com sucesso, porém contém parâmetros inválidos. Para mais detalhes, verifique o atributo errors no corpo da resposta.

429

Too Many Requests
O limite de requisições foi atingido. Verifique o cabeçalho Retry-After para obter o tempo de espera (em segundos) necessário para tentar novamente.
400
Bad Request
Não foi possível interpretar a requisição. Verifique a sintaxe das informações enviadas.
500
Internal Server Error
Ocorreu uma falha na plataforma. Por favor, entre em contato com o suporte.
No Comments
Back to top