Jak aktivovat dokumentaci na eWay-CRM® API

Popis

eWay-CRM® API nabízí možnosti komunikace s webovou službou, a to specifickými cestami. Následující článek prezentuje, jak se zaktivuje dokumentace, která pomáhá při práci s eWay-CRM® API.

Verze

Všechny verze eWay-CRM®

Obtížnost řešení

Střední

Postup řešení

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).

  1. Úpravy souboru uložte.
  2. Nyní můžete ve webovém prohlížeči zadat tuto adresu (webova_sluzba.com je nutné nahradit skutečnou adresou vaší webové služby):
http://webova_sluzba.com/WcfService/Service.svc/help
  1. Objeví se následující stránka, kde jsou vypsány jednotlivé metody, které je možné v API používat.

  1. 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).