REST-API · OpenAPI-schema

Bouw voort op PrivateCore

Een REST-API en één principe: ze draait op uw instantie, nooit op een server die u met andere klanten deelt. Online is dat de server die voor u gehuurd wordt; met de Mac mini is het het toestel aan uw toonbank. De sleutels zijn van u, en u trekt ze met één klik in.

Wat de API mogelijk maakt

  • Uw eigen hulpmiddelen koppelen: een Airtable-blad, een Slack, een verouderd ERP, een zelfgebouwd Grafana-dashboard.
  • Het terugkerende automatiseren: de terugkerende facturen van de maand aanmaken, een herinnering starten als een offerte 7 dagen ongetekend blijft, de voorraad afstemmen met een leverancier.
  • Interne toepassingen bouwen: een mobiele app voor het bedieningsteam, een reserveringswidget op uw etalagewebsite, een dashboard per vestiging op maat voor de directie.
  • Controleren en exporteren: uw hele boekhouding als JSON ophalen, het Franse FEC-bestand op afroep aanmaken, uw database spiegelen naar uw eigen datawarehouse.

Twee voorbeelden van een aanroep

TypeScript

fetch
TypeScript 
const base = 'https://votre-instance';
const headers = { Authorization: `Bearer ${process.env.PRIVATECORE_API_KEY}` };

// Klanten opvragen (sleutel met reikwijdte read:crm)
const { items, next_cursor } = await fetch(`${base}/api/public/v1/clients?limit=50`, { headers })
  .then((r) => r.json());

Python

requests
Python 
import os
import requests

base = "https://votre-instance"
headers = {"Authorization": f"Bearer {os.environ['PRIVATECORE_TOKEN']}"}

# Het FEC-bestand van het lopende boekjaar exporteren
fec = requests.get(f"{base}/api/fec/export", params={"year": 2026}, headers=headers)
open("fec_2026.txt", "wb").write(fec.content)

Authenticatie

API-sleutels met beperkte reikwijdte, intrekbaar, met een vervaldatum als u dat wilt.

  • Aanmaken: één sleutel per koppeling, vanuit de ontwikkelaarsruimte van uw instantie. U kiest de reikwijdte (klanten lezen, reserveringen lezen, enzovoort).
  • Achteraf nooit leesbaar: de sleutel wordt één keer getoond, bij het aanmaken. Uw instantie bewaart alleen een SHA-256-vingerafdruk. Kwijt? Dan trekt u hem in en maakt u een nieuwe.
  • Opvolging: elke sleutel bewaart de datum van zijn laatste gebruik, zodat u ziet welke niet meer dienen.
  • Onmiddellijke intrekking: één klik en het token is meteen ongeldig.

Gebruiksgrenzen

Geen gefactureerd quotum. Elke sleutel is beperkt tot 60 verzoeken per minuut (instelbaar op de instantie), zodat een op hol geslagen script de interface voor andere gebruikers niet vertraagt.

Daarboven antwoordt de API met 429 en een Retry-After-header: het script wacht een minuut en gaat verder.

Documentatie en status

  • Volledige documentatie: /docs op uw instantie (OpenAPI-naslag, gegenereerd uit de code).
  • Wijzigingslogboek: elke backendversie stelt een eindpunt /api/v1/changelog beschikbaar.
  • OpenAPI: OpenAPI 3.1-specificatie openlijk beschikbaar op /api/openapi.json. Compatibel met Postman, Insomnia en codegeneratoren van derden.
  • Status: de API biedt gezondheidscontroles (/health, /health/ready) die een bewakingstool kan opvragen.
API-toegang aanvragen

Klaar om het heft weer in handen te nemen?

Een installatie op maat, antwoord van de oprichter en een Mac Mini die u zelf koopt of die wij ingericht leveren.

Bestellen Spreek een oprichter