A API do beezzer fornece acesso a operações básicas em nossa base de dados. Será possível obter dados de um ticket e um clube. Além disso, criar tickets novos em um clube ou responder a algum ticket. Para ter acesso a API é necessário ter um cadastro no beezzer, pois o usuário(email) e senha serão necessários para usar o serviço.

Conceitos

Autenticação: baseada em HTTP Basic Authentication. Por enquanto é a única autenticação disponível. Deve-se usar nome de usuário e senha cadastrados no serviço.
REST: A API usa de muitos conceitos dos princípios do REST. Por exemplo, as chamadas são feitas via URLs e mudando as extensões das requisições você pode alterar o formato das respostas.
Encoding: UTF-8.
Parâmetros: utilizar encoding nos parâmetros complexos.
Formatos: XML e JSON.

Métodos

novo ticket

Cria um novo ticket em um clube definido. Requisição deve ser POST.
URL: http://pt.beezzer.com/tickets/add.xml
Formatos: xml, json.
Método: POST
Parâmetros:
* product_id. Obrigatório. Produto no qual o ticket será inserido. Basear-se na URL do produto fornecida durante o cadastro do mesmo.
* title. Obrigatório. Título do ticket. Máximo de 100 caracteres.
* type. Obrigatório. Tipo do ticket. Obrigatoriamente um dos seguintes tipos: 'dúvida', 'sugestão', 'reclamação', 'dica', 'discussão' ou ' diversão'
* text. Obrigatório. Texto do ticket. Máximo de 2000 caracteres.
* user_name. Obrigatório. Nome do usuário.
* user_email. Opcional. Email do usuário.

nova resposta

Cria uma nova resposta a um ticket de um clube definido. Requisição deve ser POST.
URL: http://pt.beezzer.com/tickets/addResposta.xml
Formatos: xml, json.
Método: POST
Parâmetros:
* ticket_id. Obrigatório, numérico.
* text. Obrigatório. Texto da resposta. Máximo de 2000 caracteres.
* user_name. Obrigatório. Nome do usuário.
* user_email. Opcional. Email do usuário.

lê ticket

Lê dados de um determinado ticket. Requisição deve ser GET.
URL: [ticket_url].xml
Formatos: xml, json.
Método: GET
Exemplo (usando curl): curl -u [USER]:[PASS] http://pt.beezzer.com/tickets/109/algumas-novidades.xml

lê clube

Lê dados de um determinado clube. Requisição deve ser GET.
URL: [produto_url].xml
Formatos: xml, json.
Método: GET
Exemplo (usando curl): curl -u [USER]:[SENHA] http://pt.beezzer.com/firefox.xml

filia-se a clube

Filia um determinado email a um clube. Se existir usuário cadastrado com tal email, um email de confirmação é enviado a ele. Caso contrário, um erro é retornado. Requisição deve ser GET.
URL: /produtosdeusuarios/apiAdd.xml
Formatos: xml, json.
Método: POST
Parâmetros:
* product_id. Obrigatório. Clube no qual o usuário(email) será adicionado.
* user_email. Obrigatório. Email do usuário.

Clube de Testes (Sandbox)

Para quem quiser testar a API sem se preocupar em "sujar" os clubes do Beezzer, criamos o clube de Testes: http://pt.beezzer.com/testes

Ajuda

Para obter suporte sobre a API do Beezzer, acesse o clube do beezzer: http://pt.beezzer.com/beezzer.