CRM Contacts API

Overzicht

De Contacts API is bedoeld voor server-to-server CRM-integraties. De API exporteert contact- en lidmaatschapsstatus, maar accepteert geen writes.

De API-key bepaalt de affiliate. Stuur geen affiliate-ID mee: een key kan alleen contacten uit de eigen tenant lezen.

• Productie-base-URL: https://api.rxapp.io
• API-versie: v1
• Scope: contacts:read
• Formaten: JSON-requests en -responses; RFC 3339 UTC-timestamps

Authenticatie

Een RxApp-affiliate-eigenaar of RxApp-support verstrekt een tenantspecifieke API-key. Stuur deze bij ieder request als Bearer-token mee.

Bewaar de key in een server-side secret manager. Plaats hem nooit in browsercode, mobiele bundels, source control, URL's of applicatielogs.

Authorization: Bearer rx_live_...

Eerste request

Vraag de eerste pagina contacten op:

curl "https://api.rxapp.io/v1/contacts?limit=100" \
  -H "Authorization: Bearer $RXAPP_CRM_API_KEY"

Voorbeeldresponse met fictieve gegevens:

{
  "items": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "contactType": "member",
      "firstName": "Alex",
      "lastName": "Example",
      "email": "alex@example.com",
      "membershipStatus": "active",
      "subscriptionPlanCode": "unlimited",
      "subscriptionPlanName": "Unlimited",
      "subscriptionStartedAt": "2026-09-01T00:00:00.000Z",
      "subscriptionEndsAt": null,
      "firstMembershipStartedAt": "2026-09-01T00:00:00.000Z",
      "version": 3,
      "updatedAt": "2026-09-25T12:00:00.000Z",
      "deletedAt": null
    }
  ],
  "page": {
    "nextCursor": null,
    "hasMore": false
  },
  "sync": {
    "watermark": "2026-09-25T12:05:00.000Z"
  }
}

Contactmodel

Gebruik id als externe identiteit en version om verouderde updates te negeren. Interne RxApp-user-ID's worden nooit getoond.

Endpoints

Beide publieke endpoints vereisen een contacts:read-key.

Lijstparameters

Vraag één contact op via de geëxporteerde UUID:

curl "https://api.rxapp.io/v1/contacts/11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer $RXAPP_CRM_API_KEY"

Veilig synchroniseren

Een watermark is het checkpoint van een volledig verwerkte paginareeks. Schuif deze nooit op na een gedeeltelijke synchronisatie.

1. 1Start met GET /v1/contacts en optionele filters, of met de laatst opgeslagen updatedAfter-watermark.
2. 2Upsert ieder item op id. Negeer een item als version niet hoger is dan de lokaal opgeslagen versie.
3. 3Als page.nextCursor gevuld is, vraag je uitsluitend ?cursor=... op en herhaal je dit totdat hasMore false is.
4. 4Controleer dat sync.watermark op iedere pagina in de reeks gelijk blijft.
5. 5Sla sync.watermark pas op nadat de laatste pagina succesvol is verwerkt.
6. 6Gebruik de opgeslagen watermark als updatedAfter voor de volgende run.
7. 7Verwijder een verlopen cursor en begin opnieuw vanaf de laatst opgeslagen watermark.

Fouten en rate limits

Foutresponses bevatten een stabiele code en X-Request-Id. Bewaar het request-ID wanneer je contact opneemt met support.

Geauthenticeerde responses bevatten X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset. Limieten worden per key ingesteld; ga niet uit van een vaste waarde.