Példaprogramok

Php példaprogramokkal látod az API működését, Curl segítségével, ezzel is kiemelve a metódusok közti különbséget.

Példa keresésre (GET):

  • Rendszer azonosító (SystemId): 50
  • API kulcs (APIKey): ZxPPCqDItuQhoaLeBM2679mT3iG5NgH1
  • Keresett projekt: Teszt projekt
//Url összeállítása
$Url = 'https://50:ZxPPCqDItuQhoaLeBM2679mT3iG5NgH1@r3.minicrm.hu/Api/R3/Project?Query=Teszt projekt';

//Curl inicializálása
$Curl = curl_init();
curl_setopt($Curl, CURLOPT_RETURNTRANSFER , true);
curl_setopt($Curl, CURLOPT_SSL_VERIFYPEER , false);

//Url átadása a Curl-nek
curl_setopt($Curl, CURLOPT_URL, $Url);

//Curl kérés lefuttatása
$Response = curl_exec($Curl);

//Curl kérés futtatásában volt-e hiba?
if(curl_errno($Curl)) $Error = "Hiba a Curl futtatásakor: ".curl_error($Curl);

//API által visszatérített http kód lekérése
$ResponseCode = curl_getinfo($Curl, CURLINFO_HTTP_CODE);
if($ResponseCode != 200) $Error = "API Hibakód: {$ResponseCode} - Üzenet: {$Response}";

//Curl lezárása
curl_close($Curl);

//Válaszban kapott JSON dekódolása és kiíratása
$Response = json_decode($Response, true);
var_export($Response);

Példa letöltésre (GET):

  • Rendszer azonosító (SystemId): 50
  • API kulcs (APIKey): ZxPPCqDItuQhoaLeBM2679mT3iG5NgH1
  • Letöltendő projekt azonosítója: 12345
//Url összeállítása
$Url = 'https://50:ZxPPCqDItuQhoaLeBM2679mT3iG5NgH1@r3.minicrm.hu/Api/R3/Project/12345';

//Curl inicializálása
$Curl = curl_init();
curl_setopt($Curl, CURLOPT_RETURNTRANSFER , true);
curl_setopt($Curl, CURLOPT_SSL_VERIFYPEER , false);

//Url átadása a Curl-nek
curl_setopt($Curl, CURLOPT_URL, $Url);

//Curl kérés lefuttatása
$Response = curl_exec($Curl);

//Curl kérés futtatásában volt-e hiba?
if(curl_errno($Curl)) $Error = "Hiba a Curl futtatásakor: ".curl_error($Curl);

//API által visszatérített http kód lekérése
$ResponseCode = curl_getinfo($Curl, CURLINFO_HTTP_CODE);
if($ResponseCode != 200) $Error = "API Hibakód: {$ResponseCode} - Üzenet: {$Response}";

//Curl lezárása
curl_close($Curl);

//Válaszban kapott JSON dekódolása és kiíratása
$Response = json_decode($Response, true);
var_export($Response);

Példa feltöltésre (PUT):

//Url összeállítása
$Url = 'https://50:ZxPPCqDItuQhoaLeBM2679mT3iG5NgH1@r3.minicrm.hu/Api/R3/Project';

//Paraméterek megadása tömb formátumban
$Params = array(
  'Name' => 'Első API projekt',
  'UserId' => 3200,
  'StatusId' => 2500,
  'CategoryId' => 3
);

//Curl inicializálása
$Curl = curl_init();
curl_setopt($Curl, CURLOPT_RETURNTRANSFER , true);
curl_setopt($Curl, CURLOPT_SSL_VERIFYPEER , false);

//Paraméterek JSON kódolása
$Params = json_encode($Params);

//Fejlécek beállítása (adat típusa, hossza és karakterkódolása)
curl_setopt($Curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json','Content-Length: '.strlen($Params), 'charset=UTF-8'));

//Kérés típusának átállítása PUT-ra
curl_setopt($Curl, CURLOPT_CUSTOMREQUEST, "PUT"); 

//Paraméterek átadása a Curl-nek
curl_setopt($Curl, CURLOPT_POSTFIELDS, $Params);

//Url átadása a Curl-nek
curl_setopt($Curl, CURLOPT_URL, $Url);

//Curl kérés lefuttatása
$Response = curl_exec($Curl);

//Curl kérés futtatásában volt-e hiba?
if(curl_errno($Curl)) $Error = "Hiba a Curl futtatásakor: ".curl_error($Curl);

//API által visszatérített http kód lekérése
$ResponseCode = curl_getinfo($Curl, CURLINFO_HTTP_CODE);
if($ResponseCode != 200) $Error = "API Hibakód: {$ResponseCode} - Üzenet: {$Response}";

//Curl lezárása
curl_close($Curl);