Par ZIP API

ZIP API ir REST API, kas izmanto HTTPS protokolu. HTTP GET, POST, PUT un DELETE metodes tiek izmantotas, lai piekļūtu API.
API ļauj pievienot, labot un dzēst savus sludinājumus.
Apskatīt PHP SDK koda piemērus.

Kā sākt

Lai sāktu lietot ZIP API, ir jāizveido API atslēga:
• Jādodas uz API sadaļu (Mani sludinājumi → API);
• Jāspiež pogu "Pievienot"
• Sarakstā tiks parādīta jaunizveidotā API atslēga

API atslēga

API atslēga ir slepena, unikāla simbolu virkne, kas tiek izmantota, lai piekļūtu API.

Turi API atslēgu drošībā, nekad neizpaud to citiem un nelieto to tīmekļa vietnes klienta puses kodā.

Autentifikācija

API pieprasījumiem ZIP API izmanto HTTP autentifikāciju.

Lai autorizētos, ir jāsūta Authorization galvene pieprasījumā, kur API atslēga tiek kodēta "Base64" kodējumā. Piemēram, ja API atslēga ir b7221dc4-b014-4a:69-a17d-73cbea837214, tad galvene API pieprasījumā būs:

Authorization: Basic YjcyMjFkYzQtYjAxNC00YTo2OS1hMTdkLTczY2JlYTgzNzIxNA==

Pieprasījumu galapunkts

Visi API pieprasījumi jāsūta uz šo tīmekļa adresi:

https://zip.lv/api/v1/

Ir iespējams arī lietot HTTP protokolu, bet drošības nolūkos tiek rekomendēts lietot HTTPS protokolu.

Pieprasījumu parametri

GET pieprasījumu parametri var tikt padoti kā GET mainīgie:

GET /ads?offset=10&limit=5

POST un PUT pieprasījumiem, lai varētu padot sarežģītākas datu struktūras, datus jāpadod JSON kodējumā pieprasījuma saturā.

POST /import

{"recipient":{...},"items":[...]}

Atbildes saturs

Atbildes saturs vienmēr ir JSON objekts, kas satur statusa kodu (atbilstošs HTTP statusa kodiem) un rezultātu. Ja statusa kods ir 200, tad vaicājums ir bijis veiksmīgs.

{
   "code": 200, // Atbildes statusa kods 
   "result":{
	  // API pieprasījuma rezultāta dati 
	  // ...
   }
}

Kļūdu atbildes

Ja API vaicājums nav bijis veiksmīgs, tad atbildes kods nav 2xx diapazonā un result satur kļūdas aprakstu.

{
   "code": 404, // Atbildes statusa kods 
   "result":"Ad not found" // Kļūdas apraksts 
}