Kur.Ir
kur.ir logo

URL saīsinātāja API

Kur.Ir API piedāvā divas REST pakalpes- datu nodošanai Kur.Ir un datu izgūšanai.
Lai izmantotu Kur.Ir API, nepieciešams unikālais API identifikators.
Savu identifikatoru varat uzzināt, autorizējoties Kur.Ir.

1. Datu nodošana
Mērķis: nodrošina URL saīsināšanu

Parametri

Parametrs Tips Obligāts
uid Lietotāja API ID formātā [A-Z]{2}[0-9]{6}[A-Z]{2}[0-9]{4} Jā
url UrlEncode kodēts pilnais URL Jā
tag Vēlamais saīsinājums- 2-20 simbolu virkne formātā [a-z0-9]{2,20} Nē

Apstrāde

  • Ja nav norādīts īpašnieka unikālais identifikators, tiek atgriezts kļūdas paziņojums SHE1;
  • Ja lietotāja unikālais identifikators ir norādīts, bet tas nav atrasts DB vai ir norādīts nekorektā formātā, tiek atgriezts kļūdas paziņojums SHE2;
  • Ja nav norādīts saīsināmais URL, tiek atgriezts kļūdas paziņojums SHE3;
  • Ja norādītā URL garums pārsniedz 2000 simbolus (pirms UrlEncode), tiek atgriezts kļūdas paziņojums SHE4;
  • Ja norādīts vēlamais saīsinājums, bet tas norādīts nekorektā formātā, tiek atgriezts kļūdas paziņojums SHE5;
  • Ja norādīts lietotāja unikālais identifikators, un saīsināmais URL šim lietotājam jau ir saglabāts pie saīsinātajām saitēm, saīsinājums tiek atgriezts atkarībā no iestatījumiem, kas piesaistīti lietotāja identifikatoram;
  • Ja norādīts vēlamais saīsinājums, bet tas jau ir izmantots, tiek atgriezts kļūdas paziņojums SHE6;
  • Ja notikusi neapstrādāta sistēmas kļūda, tiek atgriezts kļūdas paziņojums SHE0.

Izvade

Veiksmīgas izpildes gadījumā JSON objekts:
    {„Code”: „OK”, „Result”: „<Pilns saīsinātais URL>”};
Kļūdas gadījumā JSON objekts:
    {„Code”: „<Kļūdas kods>”, „Error”: „<Kļūdas paziņojums>”}:
Kods Paziņojums
SHE0 Sistēmas kļūda
SHE1 Nav norādīts īpašnieka identifikators
SHE2 Nekorekts vai neeksistējošs īpašnieka identifikators
SHE3 Nav norādīts saīsināmais URL
SHE4 URL garums pārsniedz 2000 simbolus
SHE5 Saīsinājums neatbilst garuma ierobežojumiem vai satur neatļautus simbolus
SHE6 Saīsinājums XXX jau ir aizņemts

Izmantošana

http://kur.ir/api/add?uid= &url= &tag= Izsaukt


2. Datu izgūšana
Mērķis: nodrošina URL izmantošanas statistikas izgūšanu.

Parametri

Parametrs Tips Obligāts
uid Lietotāja API ID formātā [A-Z]{2}[0-9]{6}[A-Z]{2}[0-9]{4} Nē
tag Saīsinājums formātā [a-z0-9]{2,20} Nē
url UrlEncode kodēts pilnais URL Nē

Apstrāde

  • Izsaucot pakalpi, ir jābūt norādītam vismaz vienam no parametriem. Ja nav norādīts neviens parametrs, tiek atgriezts kļūdas paziņojums STE1, ja ir norādīti visi trīs - tiek atgriezts kļūdas paziņojums STE2;
  • Ja norādīts lietotāja unikālais identifikators, tiek pārbaudīts, vai tas ir DB eksistējošs. Ja nē, tiek atgriezts kļūdas paziņojums STE3;
  • Ja lietotāja identifikatoram nav piesaistītu saīsinājumu, tiek atgriezts kļūdas paziņojums STE4;
  • Ja norādīts saīsinātais URL, tiek pārbaudīts, vai tas atbilst formātam un eksistē DB. Ja nē, tiek atgriezts kļūdas paziņojums STE5;
  • Ja norādīta nekorekta parametru kombinācija, tiek atgriezts kļūdas paziņojums STE7. Atļautās parametru kombinācijas ir: [uid],[tag],[uid + url];
  • Ja norādīts gan oriģinālais URL, gan lietotāja unikālais identifikators, tiek atgriezta statistika, par konkrēto lietotāja saīsināto garo URL, ja oriģinālais URL datubāzē nav atraststs starp lietotāja saīsinātajiem URL, tiek atgriezts kļūdas paziņojums STE6;
  • Ja norādīts tikai saīsinātais URL, tad tiek atgriezta statistika par konkrēto saiti;
  • Ja norādīts tikai lietotāja unikālais identifikators, tad tiek atgriezta statistika par visām autorizētā lietotāja saitēm;
  • Ja notikusi neapstrādāta sistēmas kļūda, tiek atgriezts kļūdas paziņojums STE0.

Izvade

Veiksmīgas izpildes gadījumā JSON objekts:
    {„Code”: „OK”, „Result”:[
    {"OriginalUrl":"<Sākotnējais URL>","Tag":"<saīsinājums>","UseCount":<izmantoto reižu skaits>,
    "CreatedDate":"<izveidošanas datums>","LastUsedDate":<pēdējās izmantošanas datums>,
    "IsActive":<pazīme, vai saīsinājums ir aktīvs>},
    …     ]}
Kļūdas gadījumā JSON objekts:
    {„Code”: „<Kļūdas kods>”, „Error”: „<Kļūdas paziņojums>”}:
Kods Paziņojums
STE0 Sistēmas kļūda
STE1 Nav norādīts neviens parametrs
STE2 Norādīti pārāk daudzi parametri
STE3 Nekorekts vai neeksistējošs īpašnieka identifikators
STE4 Īpašniekam nav neviena saīsinājuma
STE5 Nekorekts vai neeksistējošs saīsinājums
STE6 Īpašniekam šāds URL nav saīsināts
STE7 Nekorekta parametru kombinācija

Izmantošana

http://kur.ir/api/get?uid= Izsaukt (piem. DEMO)
http://kur.ir/api/get?tag= Izsaukt (piem. paraudzins)
http://kur.ir/api/get?uid= &url= Izsaukt


3. UrlEncode kodēšana
Mērķis: palīgfunkcija URL saīsināšanā

Izmantošana

URL: Nokodēt
Rezultāts:


Kur.Ir API apraksts PDF formātā pieejams šeit.