Nacházíte se zde: Úvod / Dokumentace / 6. Dodatečné funkcionality a nastavení systému / 6.8 eWay-CRM API / Základy komunikace s eWay-CRM API

Základy komunikace s eWay-CRM API

Pro základní otestování funkcionality eWay-CRM API a pro budoucí vytváření složitějších dotazů zde uvádíme jak vytvořit jednoduchý kód, který vytvoří nový kontakt v eWay-CRM. Pomocnou třídu eWayConnector, která je nutná k využití služby je možné získat na GitHub.

Důležité: Při inicializaci instance třídy eWayConnector (parametry 'http://adresa_webove_sluzby/WcfService/Service.svc/', 'user', 'password'), je potřeba zadat webovou službu a přihlašovací údaje do vašeho eWay-CRM®. Vždy se musí jednat o existující webovou službu, uživatele a správné heslo.

<?php
require_once('eway.class.php');
$connector = new eWayConnector('http://adresa_webove_sluzby/WcfService/Service.svc/', 'user', 'password');
$contact = array(
'FirstName' => 'John',
'LastName' => 'Doe',
'Email1Address' => '[email protected]'
);
// Save new contact
$result = $connector->saveContact($contact);
if ($result->ReturnCode == 'rcSuccess')
{
echo "New contact created with Guid {$result->Guid}";
}
else
{
echo "Unable to create new contact: {$result->Description}";
}

Seznam dostupných metod API

Dokumentace jednotlivých metod a jejich parametrů, je dostupná pro každou webovou službu. Zkontrolovat, zda je dokumentace zaktivována můžete na adrese vlastní webové služby, kdy ve vašem webovém prohlížeči zadáte:

http://webova_sluzba.com/WcfService/Service.svc/help

Místo části http://webova_sluzba.com zadáváte adresu vaší skutečné webové služby.

V případě, že není dokumentace na vaší webové službě aktivní, objeví se následující okno:

Pro zaktivování dokumentace postupujte podle následujícího postupu:

  1. Přejděte do složky vaší webové služby, kde naleznete složku WcfService. Tuto složku otevřete a v ní naleznete soubor Web.config. Otevřete tento soubor pro editaci.
  2. V souboru naleznete část <behaviors>, kde upravíte parametr webHttp tím, že k němu přidáte následující text: helpEnabled="true" (viz obrázek).
  3. Úpravy souboru uložte.
  4. Nyní můžete opět ve webovém prohlížeči zadat tuto adresu:
  5. http://webova_sluzba.com/WcfService/Service.svc/help
  6. Objeví se následující stránka, kde jsou vypsány jednotlivé metody, které je možné v API používat.
  7. Při kliknutí na POST se objeví podrobnosti o jednotlivých metodách. Například s jakými sloupci můžete pracovat u metody GetContacts, a to včetně příkladu (na obrázku je uvedeno pouze zkrácený výpis dokumentace pro metodu GetContacts).