Bizi API-liidese spetsifikatsioon

BIZI API-liides pakub kõikidele kasutajatele võimalust osa võtta BIZI lühiuudiste võrgu arendamisel. Teil on võimalik integreerida BIZI enda kodulehele, internetilahendustele või luua enda programme, mis kasutavad BIZI-t sõnumite saatmiseks!

Päringutes kasutatav API-liidese võti on teie kui arendaja personaalne võti.

Uudiste päringud

Avalik sein

Päring saadab vastuseks 20 avaliku seina uudist.
Toetatud formaadid: XML, JSON, RSS

Päringu URL: http://bz.ee/api/messages/public.[formaat].[oma API-liidese võti]

Sõprade uudised

Päring saadab vastuseks antud kasutaja sõprade lühiuudised.
Toetatud formaadid: XML, JSON, RSS

Päringu URL: http://bz.ee/api/messages/friends/[kasutaja].[formaat].[oma API-liidese võti]

Kasutaja uudised

Päring saadab vastuseks antud kasutaja lühiuudised.
Toetatud formaadid: XML, JSON, RSS

Päringu URL: http://bz.ee/api/messages/user/[kasutaja].[formaat].[oma API-liidese võti]

Värskeim uudis

Päring saadab vastuseks antud kasutaja kõige viimase uudise.
Toetatud formaadid: XML, JSON, RSS

Päringu URL: http://bz.ee/api/messages/latest/[kasutaja].[formaat].[oma API-liidese võti]

Saada uudis

Päring edastab BIZI avalikule seinale uue uudise ning saadab vastuseks tegevuse raporti. Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• message (uudise sisu, 140 tähemärki).

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/messages/send.[formaat].[oma API-liidese võti]

Kustuta uudis

Päring kustutab BIZI seinale postitatud uudise antud uudise ID järgi ning saadab vastuseks tegevuse raporti. Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• message_id (uudise ID).

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/messages/delete.[formaat].[oma API-liidese võti]

Otsesõnumite päringud

Kasutaja sõnumid

Päring saadab vastuseks kõik otsesõnumid, mis asuvad kasutaja postkastis. Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool).

Toetatud formaadid: XML, JSON, RSS

Päringu URL: http://bz.ee/api/direct_messages/messages.[formaat].[oma API-liidese võti]

Saada otsesõnum

Päring saadab antud kasutajale otsesõnumi ning saab vastuseks sõnumi detailid või veateate.
Päringu esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• message (uudise sisu, 140 tähemärke)

Optional parameters:

• reply (selle lühiuudise ID, millele vastatakse)
• direct (saaja kasutajanimi või ID)

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/direct_messages/send.[formaat].[oma API-liidese võti]

Kustuta otsesõnum

Päring kustutab antud lühiuudise kasutaja postkastist ning saadab vastuseks kinnitusega või veateatega. Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• message_id (lühiuudise ID)

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/direct_messages/delete.[formaat].[oma API-liidese võti]

Kasutaja päringud

Sõbrad

Päring saadab vastuseks antud kasutaja sõprade nimekirjaga.
Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/users/friends/[kasutajanimi].[formaat].[oma API-liidese võti]

Kasutaja andmed

Päring saadab vastuseks antud kasutaja andmed.
Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/users/details/[kasutajanimi].[formaat].[oma API-liidese võti]

Sõprade päringud

Hakka sõbraks

Päring lisab antud kasutaja enda sõbraks ning saab vastuseks antud sõbra andmed või veateade.
Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• friend (sõbra kasutajanimi või ID)

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/friendships/create.[formaat].[oma API-liidese võti]

Lõpeta sõprus

Päring kustutab kasutaja antud kasutaja sõprade nimekirjast ning saab vastuseks oma andmed või veateade valitud formaadis.

Päring esitatakse POST-meetodil järgnevate parameetritega:

• username (kasutajanimi või e-mail)
• password (kasutaja parool)
• friend (sõbra kasutajanimi või ID)

Toetatud formaadid: XML, JSON

Päringu URL: http://bz.ee/api/friendships/destroy.[formaat].[oma API-liidese võti]