|
|
|
Loading...

Beezzer's Public API



Beezzer's API provides access to basics operations in our database. It will be possible to obtain data from a ticket and a club. In addition, create new tickets in a club or reply to any ticket. To access the API, you must have a registration in beezzer once the user (e-mail) and password will be required to use the service.

Concepts


Authentication: Based on HTTP Basic Authentication. For now, this is the only available authentication. You must enter a user name and password.
REST: The API uses many concepts of the principles of REST. To exemplify, calls are made via URLs and, changing the extensions of requests, you can change the formats of replies.
Encoding: UTF-8
Parameters: use encoding on complex parameters.
Formats: XML and JSON.


Methods


new ticket

Creates a new ticket in a club set. Request must be POST.
URL: http://en.beezzer.com/tickets/add.xml
Formats: xml, json.
Method: POST
Parameters:
* product_id. Obligatory. Product in which the ticket will be inserted. Based on the URL of the product provided during the registration..
* title. Obligatory. Title of the ticket. Maximum of 100 characters.
* type. Obrigatory. Type of the ticket. One of the following: 'dúvida', 'sugestão', 'reclamação', 'dica', 'discussão' or ' diversão'
* text. Obligatory. Text of the ticket. Maximum 2000 characters.
* user_name. Obligatory. Username.
* user_email. Optional. E-mail User.

new reply

Creates a new reply to a ticket from a certain club set. Request must be POST..
URL: http://en.beezzer.com/tickets/addResposta.xml
Formats: xml, json.
Method: POST
Parameters:
* ticket_id. Obligatory, numerical.
* text. Obligatory. Text of response. Maximum 2000 characters.
* user_name. Obligatory. Username.
* user_email. Optional. E-mail User.

read ticket

Reads data from a particular ticket. Request must be GET.
URL: [ticket_url].xml
Formats: xml, json.
Method: GET
Example (using curl): curl -u [USER]:[PASS] http://en.beezzer.com/tickets/109/algumas-novidades.xml

read club

Reads data from a particular club. Request must be GET.
URL: [produto_url].xml
Formats: xml, json.
Method: GET
Example (using curl): curl -u [USER]:[SENHA] http://en.beezzer.com/firefox.xml


join a clube

Join an email to a club. If this email belongs to a Beezzer account, a confirmation email is sent to it. Otherwise, an error is returned. Request must be GET.
URL: /produtosdeusuarios/apiAdd.xml
Formats: xml, json.
Method: POST
Parameters:
* product_id. Obligatory. Club to which the user(email) will be added.
* user_email. Obligatory. User email..


Test Club (Sandbox)


For those who want to test the API without having to worry about "to sully" a club's image, We created The Test Club.: http://en.beezzer.com/testes


Help


For support about the Beezzer's API, visit the beezzer's club.: http://pt.beezzer.com/beezzer.
Copyright © 2012 Beezzer. All rights reserved.