SCC API – synchronizacja kontaktów
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.
Synchronizacja kontaktów
Synchronizacja jest akcją uzupełniającą do scenariusza dodawania kontaktów.
Pomocne
Synchronizacja składa się z:
- Aktualizacji listy kontaktów, bez powielania wpisów, mimo że wprowadzana lista może zawierać mieszaninę kontaktów już dodanych do SCC wcześniej i nowych.
- Aktualizacji danych w istniejących kontaktach.
Do synchronizacji danych kontaktu będą potrzebne:
- nazwa pola, według którego ma zostać określone czy jest to nowy kontakt do dodania, czy istniejący do aktualizacji danych – żeby synchronizacja zadziałała prawidłowo powinno być to pole zawierające wartości unikatowe dla każdego wpisu;
- dane kontaktów do dodania lub aktualizacji.
Żeby zsynchronizować dane kontaktowe w SCC wywołaj (dane przykładowe):
POST IntegrationApi/Record/Upsert
Przykład synchronizacji danych po polu Email, w którym przechowywane są informacje o adresie poczty elektronicznej kontaktu:
{
"record": {
"name": "Nazwa",
"firstName": "Jan",
"lastName": "Testowski",
"phoneNumber1": "123456789",
"email": "jan.testowski@systell.eu",
"region": "jan.testowski@systell.pl"
},
"syncFields": [
"record.region"
]
}
Jeśli w systemie istnieje już kontakt o danym adresie email – jego pozostałe dane zostaną zaktualizowane. Jeżeli podany adres nie znajduje się w polu Email przypisanego do żadnego z istniejących kontaktów – zostanie utworzony nowy kontakt.
Przykład dodania nowego kontaktu:
{
"operationName": "INSERT",
"records": [
{
"id": "aeca92df-6aa9-4eab-a844-7811a9989d72",
"recordNumber": "R9LCH9T1W1",
"lastUse": "1899-12-31T23:00:00Z",
"lastActiveUse": "1899-12-31T23:00:00Z",
"timeOfCreation": "2023-08-21T11:38:17Z",
"timeOfModification": "2023-08-21T11:38:17Z",
"recordItems": [],
"recordType": {
"key": "efd810b0-f462-4e01-9160-b69621b78c58",
"name": "RECORD_TYPE_RECORD",
"description": "Jestem ciekaw ile się tekstu tu zmieści (Kontakt)"
}
"parent": null,
"children": null,
"guardian": null,
"name": "Nazwa",
"firstName": "Jan",
"lastName": "Testowski",
"address": "",
"addressNumber": "",
"city": "",
"region": "jan.testowski.systell.pl",
"postCode": "",
"phoneNumber1": "123456789",
"phoneNumber2": "",
"customKey": "",
"blocked": 0,
"lifeSpan": null,
"nextId": "R9LCH9T1W1",
"email": "jan.testowski@systell.eu",
"nip": null,
"pesel": null,
"regon": null,
"krs": null,
"position": null
}
]
"succeeded": true
}
Przykład zaktualizowania istniejącego kontaktu:
{
"operationName": "UPDATE",
"records": [
{
"id": "aeca92df-6aa9-4eab-a844-7811a9989d72",
"recordNumber": "R9LCH9T1W1",
"lastUse": "1899-12-31T23:00:00Z",
"lastActiveUse": "1899-12-31T23:00:00Z",
"timeOfCreation": "2023-08-21T11:38:17Z",
"timeOfModification": "2023-08-21T11:41:37Z",
"recordItems": [],
"recordType": {
"key": "efd810b0-f462-4e01-9160-b69621b78c58",
"name": "RECORD_TYPE_RECORD",
"description": "Jestem ciekaw ile się tekstu tu zmieści (Kontakt)"
}
"parent": null,
"children": null,
"guardian": null,
"name": "Nazwa",
"firstName": "Jan",
"lastName": "Testowski",
"address": "",
"addressNumber": "",
"city": "",
"region": "jan.testowski.systell.pl",
"postCode": "",
"phoneNumber1": "123456789",
"phoneNumber2": "",
"customKey": "",
"blocked": 0,
"lifeSpan": null,
"nextId": "R9LCH9T1W1",
"email": "jan.testowski@systell.eu",
"nip": null,
"pesel": null,
"regon": null,
"krs": null,
"position": null
}
]
"succeeded": true
}
Mając token i dane kontaktów możesz wykonywać przez API inne operacje na danych, na przykład:
Tworze spraw wymaga znajomości danych kampanii i kontaktów.
Wyszukiwanie kontaktów w systemie
Identyfikatory kontaktów są potrzebne między innymi do tworzenia spraw.