Klientų sistemos API: Skirtumas tarp puslapio versijų

Iš IV pagalba klientams.
Peršokti į: navigacija, paiešką
(API naudojimo pavyzdys)
48 eilutė: 48 eilutė:
 
print_r($bonuses); // atspausdina informaciją apie kliento paskutines gautas premijas (max 100)
 
print_r($bonuses); // atspausdina informaciją apie kliento paskutines gautas premijas (max 100)
  
file_get_contents($api_url."server_reboot&id=".server_id); // perkrauna serverį
+
file_get_contents($api_url."server_reboot&id=$server_id"); // perkrauna serverį
 
</pre>
 
</pre>
  
 
[[kategorija:Bendri_klausimai]]
 
[[kategorija:Bendri_klausimai]]

14:40, 5 lapkričio 2012 versija

Prisijungimas prie API

Klientų sistemos programavimo sąsaja (API) skirta veiksmų su paslaugomis automatizavimui bei integravimui į trečųjų šalių sistemas. Prisijungimas prie API vyksta per HTTPS protokolą, rezultatai grąžinami JSON formatu.

Užklausos formatas:

https://api.iv.lt/json.php
?nick=<prisijungimo vardas>
&password=<slaptažodis>
&command=<komanda>
&id=<paslaugos id>
&...=<kiti parametrai>

Parametrų paaiškinimai:

  • prisijungimo vardas - specialaus API naudotojo vardas
  • slaptažodis - specialaus API naudotojo slaptažodis
  • komanda - komanda vykdymui, pvz., "version" arba "account_info"
  • id - paslaugos ID, kurį galite rasti per klientų sistemą paslaugos valdymo puslapyje, arba per API paslaugų sąraše
  • kiti parametrai - papildomi parametrai, priklausomai nuo konkrečios komandos

SVARBU! Prisijungimas prie API galimas tik iš IV potinklių, t.y. iš pas mus talpinamų serverių. API šiuo metu yra beta stadijos, todėl gali pasitaikyti tam tikrų klaidų, komandų ir resultatų formatas laikui bėgant gali keistis, iki 1.0 versijos šis puslapis bus vieninteliu informacijos apie naudojimasi API šaltiniu. Papildoma techninė pagalba API klausimais šiuo metu nėra teikiama.

Specialus API naudotojas

Norėdami jungtis prie klientų sistemos per API, turėsite sukurti specialų API naudotoją. Tam klientų sistemoje apsilankykite naudotojų tvarkymo puslapyje:

https://klientams.iv.lt/users.php

Ir sukurkite papildomą naudotoją su aprašymu "API" (be kabučių). Su šio naudotojo prisijungimo duomenimis galėsite jungtis prie API, tačiau ne prie klientų sistemos.

API naudojimo pavyzdys

Trumpas PHP kodo pavyzdys, iliustruojantis naudojimąsi API:

$nick = "prisijungimo vardas";
$password = "slaptažodis";
$server_id = "serverio paslaugos ID";
$api_url = "https://api.iv.lt/json.php?nick=$nick&password=$password&command=";

$account = json_decode(file_get_contents($api_url."account_info"));
$bonuses = json_decode(file_get_contents($api_url."account_bonuses&count=100"));

print_r($account); // atspausdina informaciją apie kliento paskyrą
print_r($bonuses); // atspausdina informaciją apie kliento paskutines gautas premijas (max 100)

file_get_contents($api_url."server_reboot&id=$server_id"); // perkrauna serverį