Scopes

Scopes bepalen wat een API-key mag. Geef elke key alleen wat de integratie nodig heeft.

Zo werken scopes

Bij het aanmaken van een key kies je per onderdeel of de key mag lezen (read) of ook mag schrijven (write). Write omvat aanmaken, bijwerken en verwijderen. Een request buiten de scopes van je key geeft een 403.

Beschikbare scopes

Beschikbare scopes:

Scope	Geeft toegang tot
`invoices.read` / `invoices.write`	Facturen, offertes, abonnementen (lijst/detail), betalingen, mailtemplates en e-mailtracking
`relations.read` / `relations.write`	Klanten, leveranciers, abonnementen schrijven, incasso-mandaat
`products.read` / `products.write`	Producten
`projects.read` / `projects.write`	Projecten en uren
`deals.read` / `deals.write`	Deals, pipelines en fasen
`tickets.read` / `tickets.write`	Tickets en berichten
`notes.read` / `notes.write`	Notities
`tasks.read` / `tasks.write`	Taken
`expenses.read` / `expenses.write`	Uitgaven
`files.read` / `files.write`	Bestanden
`planning.read` / `planning.write`	Planning
`webhooks.write`	AppPilot / webhook-triggers

Welke scopes heeft mijn key?

Vraag het op via /v1/me:

bash

curl -sS https://api.appficient.nl/v1/me \
  -H "Authorization: Bearer apf_jouw_key_hier"

json

{
  "data": {
    "surface": "extern",
    "actor": {
      "type": "api_key",
      "label": "Integratie"
    },
    "scopes": [
      "invoices.read",
      "invoices.write"
    ]
  },
  "meta": {}
}

Tip

Begin met read

Begin met alleen read-scopes. Voeg write pas toe op het moment dat je integratie echt gaat schrijven. Zo kan er in de tussentijd niets misgaan.