Wat is de Appficient API?

Met de Appficient API automatiseer je alles wat je in Appficient ook met de hand kunt doen: klanten aanmaken, facturen versturen, offertes opvolgen, deals verplaatsen en meer. De API is een REST API met JSON, werkt met API-keys en geeft voorspelbare responses.

API-key aanmaken

Log in op Appficient en ga naar Instellingen, daarna API. Maak daar een nieuwe key aan en kies de scopes die je integratie nodig heeft. Keys beginnen altijd met apf_.

Bewaar je key veilig

Je ziet de volledige key één keer, direct na het aanmaken. Bewaar hem in een secrets-manager of environment variable, nooit in je code of versiebeheer.

Je eerste request

Alle requests gaan naar dit adres:

bash

https://api.appficient.nl

Test eerst of je de API kunt bereiken. Hiervoor heb je nog geen key nodig:

bash

curl -sS https://api.appficient.nl/v1/ping

json

{
  "data": {
    "pong": true,
    "surface": "extern",
    "version": "v1"
  },
  "meta": {}
}

Doe daarna een request met je key. Dit endpoint laat zien welke key je gebruikt en welke scopes eraan hangen:

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": {}
}

Zie je deze response, dan werkt je integratie. Gefeliciteerd!

Volgende stappen

Authenticatie: hoe je de key meestuurt en wat je nooit moet doen.
Conventies: hoe requests en responses in elkaar zitten (envelope, paginering, filters).
Facturen: het meest gebruikte startpunt. Haal je facturen op met één GET-request.