Menu

Samenvatting van de ADP API

De ADP Worker Management API voor ADP Workforce ondersteunt een tweedelig integratiemodel: read-endpoints onder `/hr/v2/` voor het ophalen van werknemerdata, en event-endpoints onder `/events/hr/v1/` voor het doorgeven van mutaties. Autorisatie gebeurt via OAuth 2.0 met fijnmazige CAR-scopes per operatie.
  • Werknemerdata ophalen: Haal volledige werker-profielen (incl. PII) of demografische subsets op via `/hr/v2/workers` en `/hr/v2/worker-demographics`, met OData-filters op hire/terminatiedatum en status.
  • Indienst-events: Meld nieuwe indiensttredingen (`worker.hire`) en work-assignment-wijzigingen (`add`/`modify`) vanuit je ATS of recruitmentsysteem richting Workforce.
  • Contactgegevens-mutaties: Beheer zakelijke e-mail, telefoon vast en mobiel via add/change/remove-events; privé-contactgegevens zijn gedocumenteerd maar nog niet geïmplementeerd.
  • Custom fields en domeinaccount: Pas aangepaste velden aan via `worker.person.customfield.string.change`, bijvoorbeeld voor de domeinaccount van nieuwe medewerkers.
  • Event-notificaties: Abonneer op 40+ event-types (hire, terminate, workAssignment-changes, address-change, geboortedatum-change, etc.) voor realtime synchronisatie.
  • OData-queries: Uitgebreide filtering met operators `eq/lt/gt/le/ge/ne` plus `AND/OR`, inclusief `asOfDate` voor historische data-retrieval.
API Quick Facts REST
  • Authenticatie OAuth2
  • Methods GET (9)POST (22)
  • Rate limits API-calls timeouten na 1 minuut; gebruik paging ($top en $skip per 500 records) voor grote datasets
  • Webhooks Beschikbaar
  • Sandbox Niet beschikbaar
  • Response format JSON
  • Versionering URL-based

Laatste ontwikkelingen bij de ADP API

ADP Workforce, gebaseerd op het ADP Marketplace-canonical model, biedt sinds mei 2023 de Worker Management API v2 voor Nederlandse klanten met Multipay- of Prisal-loonadministratie. De API werkt met OAuth 2.0 en fijnmazige CAR-scopes per operatie. In Workforce 6.7 (juli 2024) zijn event-types toegevoegd voor wijzigingen in geboortedatum en originele indienstdatum, plus een `externalID`-veld voor koppelingen met externe systems of record. Eerdere API-versies waren SOAP-gebaseerd; de huidige v2 is volledig RESTful met OData-querying. De Marketplace code-lijst voor gender en maritalCode is verplicht (M/V/O/X respectievelijk 1-5).

API versies

Workforce 6.7 Major release
25 juli 2024

Toevoeging van event-types voor geboortedatum-wijziging, originele indienstdatum-wijziging en identificatie van externe medewerkers via externalID in worker.hire.

Worker Management API v2 Major release
1 mei 2023

Initiële publicatie van de Worker Management API voor ADP Workforce met OData-querying, event-notificaties en scope-gebaseerde OAuth 2.0-autorisatie.