REST API Dokumentacija

Įžanga

Blake.lt suteikia galimybę naudotis Application Programming Interface (API). Šiame puslapyje yra pateikta visa informaciją apie API galimybes ir naudojimą.

 

Turinys

Įžanga Turinys Versijos Koncepcija Autentifikacija REST Greičiausias būdas išbandyti Blake.lt API Žinučių metodai all account-with-friends account show add replies account-with-replies

 

Versijos

Dabartinė stabili Blake.lt API versija yra 1.0.

 

Koncepcija

 

Autentifikacija

Blake.lt API yra paremtas OAuth standartu.

request token url: http://api.blake.lt/v1/oauth/request_token

user authorization url: http://api.blake.lt/v1/oauth/authorize

access token url: http://api.blake.lt/v1/oauth/access_token

signature methods: HMAC-SHA1

request token galiojimas: 1 diena

access token galiojimas: niekada

 

Jūsų oauth_consumer_key ir oauth_consumer_secret gaunate, kai užregistruojate savo aplikaciją (tą padaryti galite parašę info@blake.lt).

 

Plačiau: OAuth tinklalapis, OAuth dokumentacija

 

REST

Blake.lt API remiasi Representational State Transfer (REST).

Palaikomi formatai: JSON ir Atom. Pagal nutylėjimą jis yra JSON.

 

Greičiausias būdas išbandyti Blake.lt API

Jeigu pas jus yra įdiegtas curl:

Viešas įrašų sąrašas: curl http://api.blake.lt/v1/messages/all/output.json

 

Žinučių metodai

 

all

Grąžina 20 paskutinių viešų žinučių. Nereikalauja autentifikacijos.

URL: http://api.blake.lt/v1/messages/all/output.formatas

Formatai: json, atom

Metodas: GET

 

account-with-friends

Grąžina 20 paskutinių nario ir jo draugų žinučių (analogiškai, kaip ir /home per Web aplinką). Reikia autentifikuotis su norimu nariu.

URL: http://api.blake.lt/v1/messages/account-with-friends/output.formatas

Formatai: json, atom

Metodas: GET

Parametrai:

• since_id. Nebūtinas.Grąžina tik naujesnius įrašus, negu nurodytas ID. Pvz.: http://api.blake.lt/v1/messages/account-with-friends/output.json?since_id=12345
• count. Nebūtinas. Skaičius nurodantis, kiek žinučių grąžinti. Negali būti daugiau nei 300. Pvz.: http://api.blake.lt/v1/messages/account-with-friends/output.json?count=5
• page. Nebūtinas. Puslapis (analogiškai grąžina, kaip ir /home per Web aplinką). Pvz.: http://api.blake.lt/v1/messages/account-with-friends/output.json?page=3

 

account

Grąžina 20 paskutinių nario žinučių.

URL: http://api.blake.lt/v1/messages/account/output.formatas

Formatai: json, atom

Metodas: GET

Parametrai:

• username. Nebūtinas. Nario vardas, jį nurodyti reikia tik tuo atveju, jeigu norite paimti ne autorizuoto vartotojo žinutes, o kito. Pvz.: http://api.blake.lt/v1/messages/account/output.json?username=aurelijus
• count. Nebūtinas. Žinučių sk. nedaugiau nei 300. Pvz: http://api.blake.lt/v1/messages/account/output.json?count=5
• since_id. Nebūtinas. Grąžina tik tas žinutes, kurios parašytos vėliau nei žinutė pagal tą ID. Pvz.: http://api.blake.lt/v1/messages/account/output.json?username=aurelijus&since_id=12345
• page. Nebūtinas. Pvz: http://api.blake.lt/v1/messages/account/output.json?username=aurelijus&page=3

 

show

Grąžina žinutę pagal ID

URL: http://api.blake.lt/v1/messages/show/id/output.formatas

Formatai: json

Metodas: GET

Parametrai:

• id. Privalomas. Žinutės ID. Pvz.: http://api.blake.lt/v1/messages/show/123/output.json

 

add

Įdėti žinutę.

URL: http://api.blake.lt/v1/messages/add/output.formatas

Formatai: json

Metodas: POST

Parametrai:

• message. Privalomas. Žinutės tekstas. Nepamirškite viską URL encodinti. Taip pat, žinutė neturi viršyti 140 simb.

 

replies

Grąžina 20 naujausių @atsakymų autentifikuotui vartotojui.

URL: http://api.blake.lt/v1/messages/replies/output.formatas

Formatai: json, atom

Metodas: GET

Parametrai:

• page. Nebūtinas. Puslapis. Pvz.: http://api.blake.lt/v1/messages/replies/output.json?page=3
• since_id. Nebūtinas. Grąžina žinutes naujesnes, nei žinutė pagal nurodytą ID. Pvz.: http://api.blake.lt/v1/messages/replies/output.json?since_id=12345

 

account-with-replies

Grąžina 20 paskutinių nario žinučių bei atsakymus į jas. Reikia autentifikuotis su norimu nariu.

URL: http://api.blake.lt/v1/messages/account-with-replies/output.formatas

Formatai: json, atom

Metodas: GET

Parametrai:

• since_id. Nebūtinas.Grąžina tik naujesnius įrašus, negu nurodytas ID. Pvz.: http://api.blake.lt/v1/messages/account-with-replies/output.json?since_id=12345
• count. Nebūtinas. Skaičius nurodantis, kiek žinučių grąžinti. Negali būti daugiau nei 300. Pvz.: http://api.blake.lt/v1/messages/account-with-replies/output.json?count=5
• page. Nebūtinas. Puslapis (analogiškai grąžina, kaip ir /home per Web aplinką). Pvz.: http://api.blake.lt/v1/messages/account-with-replies/output.json?page=3