API

Introdução

A API do Cobre Grátis é baseada nos princípios RESTful e usa conexão HTTP com todos os seus verbos (GET/POST/PUT/DELETE). Com a nossa API o seu desenvolvedor poderá integrar facilmente um programa existente à plataforma de emissão de boleto bancário.

Uso Geral

Por padrão, a API deve ser acessada através das mesmas URLs e verbos HTTP da interface HTML normal, adicionando-se o formato desejado (.xml ou .json) ao final da URL, ou então passando os headers Content-type e Accept na requisição HTTP com os valores de acordo com o formato desejado (application/xml ou application/json, respectivamente).

Convenções da API

Na documentação da API, utilizamos as seguintes convenções:

#{variable} - Indica o nome de uma variável que precisa ser substituída por valores da sua conta.
... - Indica o conteúdo da resposta de uma requisição, que foi truncado para facilitar a leitura da documentação.
$TOKEN - Indica o Token de Autenticação e está neste formato para facilitar os testes na linha de comando. Supondo que o seu token é "zjuio96wkixkzy6z98sy", você pode rodar o comando abaixo e posteriormente copiar e colar os comandos desta documentação no terminal.

export $TOKEN=zjuio96wkixkzy6z98sy

Códigos de Retorno

A API retorna o os códigos de resposta HTTP. Estas são as informações mais relevantes:

200 OK - A chamada foi bem sucedida.
400 Bad Request - A requisição é inválida, em geral conteúdo mal formado.
401 Unauthorized - O Token de Autenticação é inválido.
403 Forbidden - O plano contratado não permite acesso à API.
404 Not Found - O endereço acessado não existe.
503 Service Unavailable - A conta atingiu algum dos limites de uso.
500 Internal Server Error - Houve um erro interno do servidor ao processar a requisição.

Limitações

O servidor retorna o status HTTP 503 nas seguintes situações:

O cliente envia mais de 15 requisições por minuto.
O cliente envia mais de 500 requisições por hora.
O cliente enviar mais de uma requisição de uma só vez.