Skontaktuj się z Nami (+48) 12 446 66 66

Zintegruj CRM z innymi programami

za pomocą naszego API

Co to jest API?

API – interfejs określający sposób wymiany informacji między dwoma aplikacjami.
Nasze API odpowiada głównie za autoryzację upoważnionych programów zewnetrznych, umożliwiając im pobranie lub przysłanie danych z zewnątrz.
Możliwości te ograniczone są zarówno poprzez sam interfejs jak i uprawnienia dla upoważnionej aplikacji.
Oznacza to, że API jest szybkim i bezpiecznym sposobem na współpracę dwóch programów poprzez wymianę danych.

Aby skorzystać z naszego API aplikacja zewnętrzna musi otrzymać dane do autoryzacji – client ID oraz client Secret – za pomocą których generuje dla siebie tymczasowy token. Token uprawnia do wykonywania wywołań API w jednej z 4 kategorii:

  1. CREATE – tworzenie nowych rekordów w systemie np. zarejestrowanie nowego klienta jako lead.
  2. READ – odczytanie danych zapisanych jako rekord/y np. do pobranie informacji o ofercie, grupie ofert.
  3. UPDATE – aktualizacja danych w rekordzie np. zmiana numeru telefonu w kontakcie.
  4. DELETE – usunięcie danego rekordu np. wycofanie błędnego zamówienia.

Krótki opis API

Dostęp API realizowany jest poprzez REST API, z dostępem oauth2.

Adres do pobierania tokenu oauth2:

https://TWOJA_NAZWA_APLIKACJI.egito.pl/oauth/token?grant_type=password&client_id=MY_ID_TOKEN&client_secret=MY_SECRET_TOKEN&password=PASSWORD&username=USERNAME

Pobieranie słowników:
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/SelectDictionary/list?type=TYP_SLOWNIKA[industry|relationshipType|etc]

Wszystkie metody api przyjmują jsona lub parametry POST takie jak wysyła przeglądarka w normalnym systemie podczas zapisywania formularzy.
Jeżeli wykonywana operacja zakończy się sukcesem rezultatem będzie JSON z id zapisanego obiektu.
Jeżeli wykonywana operacja zakończy się niepowodzeniem rezultatem będzie JSON z listą błędów (pole errors).

Podstawowe metody z przykładami do użycia w Egito API:

Metoda CREATE przykłady:
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Account/create
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Contact/create
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Opportunity/create

Metoda GET przykłady:
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Account/get
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Contact/get
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Opportunity/get

Metoda UPDATE przykłady:
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Account/update
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Contact/update
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Opportunity/update

Metoda LIST przykłady:
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Account/list
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Contact/list
https://TWOJA_NAZWA_APLIKACJI.egito.pl/services/restapi/json/Opportunity/list

Przykłady wykorzystania API

Paczka ZIP do pobrania.

Top