API

Frappe biedt een REST API voor elk DocType en elke whitelisted methode. U schrijft geen endpoints — u definieert data en code, het framework genereert de API.

Twee URL-families

Endpoint	Gebruik
`/api/resource/<DocType>`	CRUD op records — list, get, create, update, delete
`/api/method/<dotted.path>`	Een whitelisted Python-functie aanroepen

Authenticatie

Drie opties:

Methode	Geschikt voor
API-sleutel + secret	Server-to-server scripts, langlopende integraties
OAuth 2.0	Externe apps die namens een gebruiker handelen
Sessiecookie	Ingelogde browsergebruikers

Genereer een API-sleutel via User → API Access.

Voorbeeld: facturen ophalen

curl 'https://mysite/api/resource/Sales Invoice' \
  -H 'Authorization: token <api_key>:<api_secret>' \
  -d 'fields=["name","customer","grand_total","posting_date"]' \
  -d 'filters=[["docstatus","=",1],["posting_date",">=","2026-01-01"]]'

Voorbeeld: methode aanroepen

curl -X POST 'https://mysite/api/method/my_app.api.run_report' \
  -H 'Authorization: token <api_key>:<api_secret>' \
  -d 'report_name=Sales Summary' -d 'year=2026'

Client SDKs

frappe-js-sdk — vanilla JS / TypeScript
frappe-react-sdk — React-hooks met caching
frappe-client — officiële Python-client

Webhooks

Voor uitgaande notificaties (document ingediend, status gewijzigd) gebruikt u het Webhook DocType in het desk. Het stuurt een HTTP POST naar uw URL bij het ingestelde event.