API

Autenticação

Todo acesso à API do Cobre Grátis é feito do ponto de vista de um usuário. Assim sendo, toda requisição à API deverá ser autenticada. A autenticação é feita via HTTP Basic, porém ao invés de passar o login e senha do usuário, como é tradicional, deve-se fornecer o Token de Autenticação do usuário no campo ‘login’ e nada no campo ‘password’. Alguns clientes HTTP podem reclamar do fato do campo ‘password’ estar vazio, nesse caso pode-se informar ‘X’ como senha, que o sistema irá ignorar.

O Token de Autenticação pode ser obtido no link Minhas Informações dentro do Cobre Grátis.

Exemplo de chamada API autenticada (onde "zjuio96wkixkzy6z98sy" é o Token de Autenticação do usuário):

$ curl -i -u zjuio96wkixkzy6z98sy:X -X GET \
https://app.cobregratis.com.br/bank_billets/1.xml

HTTP/1.1 200 OK
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/xml; charset=utf-8
...

<?xml version="1.0" encoding="UTF-8"?>
<bank_billet>
  <id type="integer">1</id>
  ...
</bank_billet>

Já a mesma solicitação sem os parâmetros de autenticação (ou com valores errados), resultaria em:

$ curl -i -X GET \
https://app.cobregratis.com.br/bank_billets/1.xml

HTTP/1.1 401 Unauthorized
Date: Fri, 05 Nov 2010 12:00:00 GMT
Content-Type: application/xml; charset=utf-8
...

<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <error>Email ou senha inválidos.</error>
</hash>