TLDR: Kontakter stöder externa ID:n utöver Adversus (interna) ID:n.
När Adversus integreras med externa system är det viktigt att hålla reda på kontaktenhetsystemen däremellan. För det ändamålet använder vi en identifierare som kan komma från Adversus eller den externa tjänsten.
När nya kontakter skickas till Adversus med POST kan ett externt ID läggas till i begäran.
Fältet för externt ID fungerar som en unik identifierare. Det är inte tillåtet att skapa fler än en kontakt med samma externa ID.
curl --location --request POST 'https://api.adversus.io/contacts' \--header 'Authorization: Basic XX' \--header 'Content-Type: application/json' \--data-raw ' { "poolId": 25518, "externalId": "ABCD1234", "data": { "1": "John Doe", "2": "+1 (337) 385 5102" }}'
Både det interna (Adversus) och externa ID:t är synliga från Warehouse och tillgängliga i PATCH-förfrågningar (med antingen det interna eller externa ID:t).
Vad händer om kontakter laddas upp utan externt ID?
I fall där vi vill hålla manuellt uppladdade kontakter uppdaterade från API:et – men inget externt ID läggs till under importen – är det möjligt att söka efter kontakter med hjälp av nyckel/värdepar, till exempel ett företagsregistreringsnummer eller liknande. Det är även möjligt att söka efter kontakter baserat på flera fält med hjälp av sammankopplade fältvärden.
Dessa requests görs med hjälp av kontakterna findByData-endpoint.
curl --location --request POST 'https://api.adversus.io/contacts/findByData' \--header 'Authorization: Basic XX' \--header 'Content-Type: application/json' \--data-raw '{ "1": "John Doe", "2": "+1 (337) 385 5102"}'
Endpunkten returnerar det interna ID:t, som sedan kan användas för vidare bearbetning.
Observera att det generellt sett anses vara bästa praxis att använda antingen det interna eller externa ID:t, vilket också ger snabbare svarstider.