Ważne
Chcąc uzyskać dostęp do API integracyjnego, konieczne jest posiadanie tokena autoryzacyjnego.
Pojedynczy kontakt w systemie, to zbiór danych dotyczących osoby lub przedsiębiorstwa, takich jak nazwisko lub nazwa, kontaktowy numer telefonu czy adres email.
Jeśli chcesz dodawać lub synchronizować dane kontaktów w SCC, będzie Ci potrzebna lista pól danych kontaktu. Najpewniejszą metodą jej uzyskania jest pobranie również przez API.
Tą metodą uzyskasz listę wszystkich parametrów kontaktu, także tych dodatkowych, które zostały skonfigurowanie w czasie wdrażania systemu (na przykład Testowe Pole).
Aby pobrać definicje pól kontaktu wywołaj (dane przykładowe):
GET IntegrationApi/Record/GetDefinitions
{ "record":[ { "key": "Name", "value": "Firma" }, { "key": "FirstName", "value": "Imię" }, { "key": "LastName", "value": "Nazwisko" }, { "key": "Adress", "value": "Adres" }, { "key": "PhoneNumber1", "value": "Telefon 1" }, { "key": "RecordEmail", "value": "Email" }, { "key": "PESEL", "value": "PESEL" }, { "key": "REGON", "value": "REGON" }, { "key": "KRS", "value": "KRS" }, { "key": "NIP", "value": "NIP" }, { "key": "Position", "value": "Stanowisko" } ] "recordItems":[ { "key": "Testowe_Pole", "value": "Testowe_Pole" } ] }
Gdzie, w otrzymanym rezultacie:
Mając token i listę pól danych kontaktu możesz wykonywać przez API inne operacje na danych, na przykład:
Dodawanie kontaktów do systemu
Dodawanie nowych kontaktów bez weryfikacji powtórzeń.
Synchronizacja kontaktów (aktualizacja)
Aktualizacja istniejących danych i dodawanie nowych kontaktów.