Docs - Brasil Open Badge

Informações do Emissor

Visão Geral

Esta consulta é realizada caso você precise acessar algum registro do seu cadastro de emissor em nossa plataforma.

Observação

A autenticação é necessária através do Token. Veja mais sobre autenticação e Token.

Iniciando a consulta

É necessário o Token para realizar qualquer consulta.

POST /api/emissor?token={{token}}&tipo={{tipo}}

Exemplo:

x-www-form-urlencoded

/api/emissor?token={{token}}&tipo={{tipo}}

Parâmetros da API

Parâmetro	Descrição
`token`	Presença: Obrigatória. Tipo: Texto. Formato: Fornecido no painel do emissor
`tipo`	Presença: Obrigatória. Tipo: Texto. Formato: json ou xml

Retorno (JSON)

{
  "response": "true",
  "token": "7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D",
  "id": "26", 
  "nome": "BRASIL OPEN BADGE", 
  "site": "www.brasilopenbadge.com.br"
}

Retorno (XML)

<emissor>
    <response>true</response>
    <token>7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D</token>
    <id>26</id>
    <nome>BRASIL OPEN BADGE</nome>
    <site>www.brasilopenbadge.com.br</site>
</emissor>

Consulta de consumo

Visão Geral

Realiza a consulta do consumo.

Iniciando a consulta

É necessário o Token para realizar qualquer consulta.

POST /api/v1/emissor_credito?token={{token}}&tipo={{tipo}}

Exemplo:

x-www-form-urlencoded

/api/v1/emissor_credito?token={{token}}&tipo={{tipo}}

Parâmetros da API

Parâmetro	Descrição
`token`	Presença: Obrigatória. Tipo: Texto. Formato: Fornecido no painel do emissor
`tipo`	Presença: Obrigatória. Tipo: Texto. Formato: json ou xml

Retorno (JSON)

{
  "response": "true",
  "token": "7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D",
  "amount": "2500"
}

Retorno (XML)

<creditos>
    <response>true</response>
    <token>7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D</token>
    <amount>2500</amount>
</creditos>

Tabela de Erros

Ocorre quando um ou mais dados foram encaminhados de forma incorreta ou fora do padrão.

Retorno da API

Parâmetro	Descrição
`response`	true ou false
`data`	Tipo: Texto. Formato: Informação do erro.

Retorno (JSON)

{
  "response": "false", 
  "data": "XXXXXXXXXX"
}

Retorno (XML)


<creditos>
    <response>false</response>
    <data>XXXXXXXXXX</data>
</creditos>