API REST · schéma OpenAPI

Construisez sur PrivateCore

Une API REST et un principe : elle tourne sur votre instance, jamais sur un serveur partagé avec d'autres clients. En ligne, c'est le serveur loué pour vous ; avec le Mac mini, c'est la machine de votre comptoir. Les clés sont à vous, et vous les révoquez d'un clic.

Ce que l'API permet

  • Connecter vos outils custom : un tableau Airtable, un Slack, un ERP legacy, un tableau de bord Grafana maison.
  • Automatiser ce que vous répétez : générer les factures récurrentes du mois, déclencher une relance quand un devis reste non signé 7 jours, synchroniser les stocks avec un fournisseur.
  • Construire des apps internes : une app mobile pour l'équipe de salle, un widget réservation sur votre site vitrine, un dashboard multi-site custom pour la direction.
  • Auditer et exporter : rapatrier toute votre compta en JSON, générer un FEC à la demande, miroir de votre base vers votre propre data warehouse.

Deux exemples d’appel

TypeScript

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

// Lister les clients (clé de portée 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']}"}

# Exporter le FEC de l'exercice en cours
fec = requests.get(f"{base}/api/fec/export", params={"year": 2026}, headers=headers)
open("fec_2026.txt", "wb").write(fec.content)

Authentification

Des clés d'API à portée limitée, révocables, avec une date d'expiration si vous le souhaitez.

  • Création : une clé par intégration, depuis l'espace Développeur de votre instance. Vous choisissez ses portées (lecture des clients, des réservations, etc.).
  • Jamais lisibles après coup : la clé s'affiche une seule fois, à sa création. Votre instance n'en garde qu'une empreinte SHA-256. Si vous la perdez, vous la révoquez et vous en créez une autre.
  • Suivi : chaque clé garde sa date de dernière utilisation, pour repérer celles qui ne servent plus.
  • Révocation instantanée : un clic suffit. Le token devient immédiatement invalide.

Rate limits

Aucun quota facturé. Chaque clé est limitée à 60 requêtes par minute (réglable sur l'instance), pour qu'un script emballé ne ralentisse pas l'interface des autres utilisateurs.

Au-delà, l'API répond 429 avec un en-tête Retry-After : le script attend une minute et reprend.

Documentation & statut

  • Docs complètes : /docs sur votre instance (référence OpenAPI générée depuis le code).
  • Changelog : chaque version du backend expose un endpoint /api/v1/changelog.
  • OpenAPI : spec OpenAPI 3.1 disponible en clair à /api/openapi.json. Compatible Postman, Insomnia, code generators tiers.
  • Statut : l'API expose des points de santé (/health, /health/ready) qu'un outil de supervision peut interroger.
Demander un accès API

Prêt à reprendre le contrôle ?

Une installation sur mesure, une réponse du fondateur, et un Mac Mini que vous achetez vous-même ou que nous livrons configuré.

Commander Contacter un fondateur