Référence API
Liste complète des endpoints REST v1, conventions et lien vers la spec OpenAPI 3.1.
L'API Inkr expose 15 endpoints REST sous https://api.getinkr.eu/v1. Cette page liste tous les endpoints avec un lien vers la doc détaillée. Pour un viewer interactif, télécharge la spec OpenAPI 3.1 et charge-la dans ton outil préféré (Insomnia, Bruno, Postman, Stoplight, etc.).
Spec OpenAPI 3.1
curl https://api.getinkr.eu/openapi.yaml -o inkr-openapi.yamlCompatible OpenAPI Generator, Speakeasy, Fern, Stainless pour générer des SDK dans 25+ langages.
Conventions globales
| Convention | Valeur |
|---|---|
| Base URL | https://api.getinkr.eu/v1 |
| Auth | Authorization: Bearer sk_test_xxx ou sk_live_xxx |
| Idempotency | Header Idempotency-Key obligatoire sur tout POST mutant |
| Pagination | Cursor via ?cursor=<opaque>&limit=<n> (max 100) |
| Format IDs | Strings préfixées : tpl_, sub_, sbm_, evt_, whk_ |
| Erreurs | Enveloppe normée { "error": { "type", "code", "message" } } |
| Timestamps | ISO 8601 UTC partout |
| Rate limit | 100 rpm (sk_test) / 1000 rpm (sk_live) |
Endpoints
Authentification
Templates
PDF figés réutilisables avec leurs champs positionnés. Documentation détaillée.
| Méthode | Path | Description |
|---|---|---|
GET | /v1/templates | Lister les templates (cursor pagination). |
POST | /v1/templates | Créer un template depuis un PDF + champs. |
GET | /v1/templates/{id} | Récupérer un template. |
DELETE | /v1/templates/{id} | Archiver un template. |
Submissions
Instances de signature envoyées à 1 ou N signataires. Documentation détaillée.
| Méthode | Path | Description |
|---|---|---|
POST | /v1/submissions | Créer une submission depuis un template. |
POST | /v1/submissions/from_pdf | Créer une submission depuis un PDF inline (template ad-hoc). |
GET | /v1/submissions | Lister les submissions (filtres status, template_id). |
GET | /v1/submissions/{id} | Récupérer une submission. |
DELETE | /v1/submissions/{id} | Annuler une submission. |
GET | /v1/submissions/{id}/documents | Télécharger le PDF signé (URL signée TTL 1h). |
GET | /v1/submissions/{id}/audit_log | Télécharger l'audit PDF eIDAS. |
Submitters
Signataires individuels d'une submission. Documentation détaillée.
| Méthode | Path | Description |
|---|---|---|
GET | /v1/submitters | Lister tous les submitters (filtres status, submission_id). |
GET | /v1/submitters/{id} | Récupérer un submitter avec ses values signées. |
PATCH | /v1/submitters/{id} | Mettre à jour email, phone ou name (status pending ou opened). |
POST | /v1/submitters/{id}/embed_token | Régénérer un JWT embed (TTL custom). |
Webhooks
Events submission envoyés en push HTTP signé HMAC. Documentation détaillée.
| Méthode | Path | Description |
|---|---|---|
GET | /v1/webhook_endpoints | Lister les endpoints webhook configurés. |
POST | /v1/webhook_endpoints | Créer un endpoint webhook. |
DELETE | /v1/webhook_endpoints/{id} | Désactiver un endpoint webhook. |
Health
| Méthode | Path | Description |
|---|---|---|
GET | /v1/health | Status check public (pas d'auth requise). |
Codes HTTP
| Code | Sens |
|---|---|
200 | Succès. |
201 | Ressource créée. |
204 | Succès sans body (DELETE typique). |
400 | Validation Zod refusée ou Idempotency-Key manquante. |
401 | Clé API manquante, invalide ou révoquée. |
403 | Clé valide mais ressource hors scope. |
404 | Ressource inexistante. |
422 | Idempotency mismatch (même clé, body différent). |
429 | Rate limit dépassé (cf. header Retry-After). |
500 / 502 / 503 | Erreur Inkr ou upstream (retry recommandé). |
Détail complet des error.code dans Erreurs et retries.
SDKs et outils communautaires
Aucun SDK officiel maintenu par Inkr en MVP. Inkr publie la spec OpenAPI 3.1 stable et recommande de générer ton client via :
OpenAPI Generator
Générateur multi-langage open source (Java, Python, TypeScript, Go, etc.).
Speakeasy
SDK générés type-safe avec retry, idempotency, pagination intégrés.
Fern
Génération SDK + doc + Postman depuis un schema unique.
Stainless
SDKs idiomatiques générés par Stripe / Anthropic / Cloudflare.
Versioning
L'API est en version v1. Les changements breaking déclenchent une nouvelle version (v2, v3). Les changements rétrocompatibles (nouveaux endpoints, nouveaux champs optionnels) restent sur v1.
Toute deprecation est annoncée 6 mois à l'avance via le header HTTP Sunset sur les endpoints concernés + email aux développeurs ayant utilisé une clé sk_live dans les 30 derniers jours.