Docs - Brasil Open Badge

Informações de um badge

Visão Geral

Realiza a consulta de informações de um determinado badge.

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/badge?token={{token}}&tipo={{tipo}}&nome={{nome}}

Exemplo:

x-www-form-urlencoded

/api/badge?token={{token}}&tipo={{tipo}}&nome={{nome}}

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
`nome`	Presença: Obrigatória. Tipo: Texto. Formato: nome completo do badge

Retorno (JSON)

{
  "response": "true",
  "token": "7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D",
  "idbadge": "93", 
  "nome": "CAPACITAÇÃO COMERCIAL", 
  "emp_nome": "BRASIL OPEN BADGE", 
  "descricao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus", 
  "criterios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus"
}

Retorno (XML)

<badge>
    <response>true</response>
    <token>7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D</token>
    <idbadge>93</idbadge>
    <nome>CAPACITAÇÃO COMERCIAL</nome>
    <emp_nome>BRASIL OPEN BADGE</emp_nome>
    <descricao>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</descricao>
    <criterios>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</criterios>
</badge>

Criar badge

Visão Geral

Possibilita a criação de um badge.

Iniciando a criação

É necessário o Token para criar o badge.

POST /api/cria_badge?data={{json}}

Exemplo:

x-www-form-urlencoded

/api/cria_badge?data={{json}}

Estrutura data (POST-JSON)

{
  "Criacao":
      [
        {
          "token": "valor",
          "nome": "nome badge",
          "validade_tipo": "0",
          "validade_tempo": "0",
          "descricao": "",
          "criterios": "",
          "evidencia": "false", 
          "imagem": "url", 
        }
      ]
}

Parâmetros da API

Parâmetro	Descrição
`token`	Presença: Obrigatória. Tipo: Texto. Formato: Fornecido no painel do emissor
`nome`	Presença: Obrigatória. Tipo: Texto. Formato: Nome do badge (max. 50 caracteres)
`validade_tipo`	Presença: Obrigatória. Tipo: Valor pré-definido. Formato: dia, mes, ano ou 0(ilimitado)
`validade_tempo`	Presença: Obrigatória. Tipo: Número. Formato: período de validade pelo tipo acima
`descricao`	Presença: Obrigatória. Tipo: Texto. Formato: Descrição do badge
`criterios`	Presença: Obrigatória. Tipo: Texto. Formato: Critérios do badge
`evidencia`	Presença: Obrigatória. Tipo: Booleano. Formato: true ou false
`imagem`	Presença: Obrigatória. Tipo: Link. Formato: Url da imagem do badge (ex. http://www.meusite.com/imagem.png)

Retorno (JSON)

{
  "response": "true", 
  "data": "200",
  "info": "Badge criado"
}

Lista de badges

Visão Geral

Realiza a consulta da lista de todos os badges.

Iniciando a consulta

É necessário o Token para realizar qualquer consulta.

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

Exemplo:

x-www-form-urlencoded

/api/badge_all?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)

{ 
"Badges": [
{
  "response": "true",
  "token": "7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D",
  "idbadge": "93", 
  "nome": "CAPACITAÇÃO COMERCIAL", 
  "emp_nome": "BRASIL OPEN BADGE", 
  "descricao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus", 
  "criterios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus"
},{
  "response": "true",
  "token": "7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D",
  "idbadge": "94", 
  "nome": "CAPACITAÇÃO COMERCIAL 2", 
  "emp_nome": "BRASIL OPEN BADGE", 
  "descricao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus", 
  "criterios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus"
}]
}

Retorno (XML)

<badges>
    <badge>
        <response>true</response>
        <token>7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D</token>
        <idbadge>93</idbadge>
        <nome>CAPACITAÇÃO COMERCIAL</nome>
        <emp_nome>BRASIL OPEN BADGE</emp_nome>
        <descricao>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</descricao>
        <criterios>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</criterios>
    </badge>
    <badge>
        <response>true</response>
        <token>7701A91E70ED3093246130C39DB9C34B3290C02724142BD7D9E91887B42DAB1D</token>
        <idbadge>94</idbadge>
        <nome>CAPACITAÇÃO COMERCIAL 2</nome>
        <emp_nome>BRASIL OPEN BADGE</emp_nome>
        <descricao>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</descricao>
        <criterios>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed lacinia, enim a sagittis aliquet, nulla libero rutrum lacus</criterios>
    </badge>
</badges>

Emitir Badges

Visão Geral

Realiza a emissão de badges via API POST.

Iniciando a emissão

Para realizar a emissão necessita do Token e a liberação nas configurações.

POST /api/badge_emite?token={{token}}&earn={{ganhador}}&earn_email={{ganhador_email}}&badge={{badge}}&testemunho={{testemunho}}&evidencia={{evidencia}}&tipo={{tipo}}

Exemplo:

x-www-form-urlencoded

/api/badge_emite?token={{token}}&earn={{ganhador}}&earn_email={{ganhador_email}}&badge={{badge}}&testemunho={{testemunho}}&evidencia={{evidencia}}&tipo={{tipo}}

Parâmetros da API

Parâmetro	Descrição
`token`	Presença: Obrigatória. Tipo: Texto. Formato: Fornecido no painel do emissor
`ganhador`	Presença: Obrigatória. Tipo: Texto. Formato: nome do ganhador do badge
`ganhador_email`	Presença: Obrigatória. Tipo: E-mail @. Formato: e-mail do ganhador do badge
`badge`	Presença: Obrigatória. Tipo: Texto ou Número. Formato: nome do badge ou id do badge id do badge Em informações do badge: `POST /api/badge?token={{token}}&tipo={{tipo}}&nome={{nome}}` Retorno (JSON) `... "idbadge": "93", ...` Retorno (XML) `... <idbadge>93</idbadge> ...`
`testemunho`	Presença: Obrigatória. Tipo: Texto. Formato: texto do testemunho
`evidencia`	Presença: Obrigatória. Tipo: Texto. Formato: texto da evidência
`tipo`	Presença: Obrigatória. Tipo: Texto. Formato: json ou xml

Retorno (JSON)

{
  "response": "true", 
  "data": "200"
}

Retorno (XML)

<emissao>
    <response>true</response>
    <data>200</data>
</emissao>

Retorno da API

Todo envio de emissão retornará um resultado que pode ser tratado conforme as informações abaixo.

data	descrição
`200`	Emitido com sucesso.
`400`	Operação não autorizada.
`401`	Token inválido.
`402`	E-mail de ganhador inválido.
`403`	Badge inválido ou inexistente.
`404`	Evidência inválida.
`500`	Erro inesperado no servidor.