Nacházíte se zde: Úvod / Dokumentace / 6. Dodatečné funkcionality a nastavení systému / 6.8 eWay-CRM API / Získávání, ukládání a vyhledávání v záznamech

Získávání, ukládání a vyhledávání v záznamech

Moduly, které jsou prostřednictvím eWay-CRM® API dostupné, mají metody, které je možné volat. Základní metody jsou (XXX je při komunikaci nahrazeno skutečným jménem modulu):

  • SaveXXX - umožňuje uložit záznam
  • SearchXXX - umožňuje vyhledávat v záznamech
  • GetXXX - umožňuje získat záznamy

Vzhledem k tomu, že metody jsou obdobné pro všechny moduly a jejich seznam je možné získat po aktivaci dokumentace přímo na webové službě, bude jejich použití prezentováno na modulu Kontakty. Obdobně se pak aplikují metody i na ostatních modulech.

Metoda SaveContact

Metoda SaveContact je využívána pro uložení nového kontaktu do eWay-CRM®. Níže popíšeme příklad jejího volání v rámci PHP skriptu a následně jak vypadají návratové hodnoty. Dostupné parametry naleznete po aktivování pomocné dokumentace na webové službě.

Nejprve si musíme definovat položku (v tomto případě kontakt), kterou chceme vytvořit - vytvoříme si tedy proměnnou, do které uložíme pole s parametry nového kontaktu.

$contact = array(
    'FirstName' => 'Robert',
    'LastName' => 'Doe',
    'Email1Address' => '[email protected]',
    'TelephoneNumber1' => '586987456',
    'BusinessAddressStreet' => 'Atlantic Ave',
    'AdditionalFields' => array ( 'af_18' => 'Snowboarding',
    'af_146' => '8.11.2005')
);

Následně využijeme proměnné $connector a zavoláme metodu SaveContact a jako parametr jí udáme naši proměnnou $contact.

$result = $connector->SaveContact($contact);

Poté si pro ověření vytvoříme následující jednoduchou podmínku a v případě úspěchu si necháme vypsat identifikační číslo nově vytvořené položky. V případě neúspěchu notifikaci s bližšími informacemi k problému.

if ($result->ReturnCode == 'rcSuccess')
{
    print ("New contact created with Guid " . $result->Guid);
}
else
{ print("Unable to create new contact:" . $result->Description); }

Výsledek poté bude vypadat následovně:

Editaci kontaktu poté provádíme tak, že do položky kontaktu přidáme identifikátor ItemGUID a verzi položky ItemVersion, kterou jé potřeba při každém dalším volání zvedat o jedna.

$contact = array(
    'ItemGUID' => 'b604815a-8cce-4600-ae22-8bc38e4c8f66'
    'ItemVersion' => '2',
    'TelephoneNumber1' => '+420586987456'
);

Více ukázek editace je k dispozici na GitHub.

Metoda SearchContacts

Metoda SearchContacts je využívána pro nalezení konkrétního kontaktu v eWay-CRM®. Níže popíšeme příklad jejího volání v rámci PHP skriptu a následně jak vypadají návratové hodnoty. Dostupné parametry naleznete po aktivování pomocné dokumentace na webové službě.

Nejprve si musíme definovat položku (v tomto případě kontakt), kterou chceme nalézt - vytvoříme si tedy proměnnou, do které uložíme pole s parametry hledaného kontaktu.

$contact = array(
    'FirstName' => 'Robert',
    'LastName' => 'Doe',
    'Email1Address' => '[email protected]',
);

Následně opět na proměnné $connector zavoláme metodu SearchContacts.

$result = $connector->SearchContacts($contact);

Pro formátovaný a čitelný výpis poté výsledek hledání necháme vypsat následovně.

if ($result->ReturnCode == 'rcSuccess')
{
    print("<pre>");
    print_r($result->Data);
    print("</pre>");
}
else
{
    print("Unable to get contact:" . $result->Description);
}

A opět doplníme o výpis chyby v případě neúspěchu.

Výsledek poté bude vypadat např. následovně:

Nemusí nás však zajímat všechny informace, proto pak stačí specifikovat výpis např. následovně.

print($result->Data[0]->BusinessAddressStreet); 

a získáme tak pouze konkrétní informaci:

Metoda GetContacts

Metoda GetContacts je využívána pro získání všech kontaktů v eWay-CRM®. Níže popíšeme příklad jejího volání v rámci PHP skriptu a následně jak vypadají návratové hodnoty.

Tentokrát není třeba specifikovat žádné parametry pro metodu GetContacts a přejdeme rovnou k jejímu volání. Využijeme proměnné $connector a zavoláme metodu GetContacts bez parametrů.

$result = $connector->GetContacts();

Pro formátovaný a čitelný výpis poté výsledek hledání necháme vypsat následovně.

if ($result->ReturnCode == 'rcSuccess')
{
    print("<pre>");
    print_r($result->Data);
    print("</pre>");
}
else
{
    print("Unable to get contacts: " . $result->Description);
}

Výsledek poté bude výpis všech kontaktů, jehož část bude vypadat následovně (jedná se pouze o část celkového výsledku - výpisu všech kontaktů)

Formát si opět můžete libovolně upravit pomocí PHP.