API REST
Créez, configurez et supprimez des formulaires, lisez les soumissions, gérez le spam, et gérez les endpoints de webhook et leurs livraisons avec une clé secrète.
L'API REST permet à votre serveur de créer, configurer, mettre en pause et supprimer des formulaires et leurs schémas de champs, de lire les soumissions, de les déplacer vers le spam ou de les en sortir et de les supprimer, et de créer, modifier, tester et rejouer des endpoints de webhook. C'est du JSON en HTTPS à l'adresse https://ikiform.com/api/v1. Le document OpenAPI 3.1 se trouve à l'adresse /api/v1/openapi.json.
/api/v1. Envoyez plutôt vers l'endpoint du formulaire avec une clé secrète ; voir Depuis un serveur.Vous travaillez avec un agent IA comme Claude Code ou Cursor ? Connectez plutôt le serveur MCP : il propose les mêmes actions sous forme d'outils, avec les mêmes clés et portées.
Clés API
Créez des clés dans le tableau de bord sous API keys. Une clé appartient à un seul espace de travail et ne voit que celui-ci. La clé complète n'est affichée qu'une fois ; Ikiform n'en stocke que le hachage.
| Type | Préfixe | Utilisation |
|---|---|---|
| Secrète | ik_sk_ | Pour les serveurs. Appelle l'API REST avec les portées choisies, et peut créer des soumissions. |
| Publiable | ik_pub_ | Pour les navigateurs. Peut seulement soumettre des formulaires, et uniquement depuis les domaines listés sur la clé. |
Portées
| Portée | Autorise |
|---|---|
forms:read | GET /forms, GET /forms/:formId |
forms:write | POST /forms, PATCH et DELETE /forms/:formId, PUT et DELETE /forms/:formId/fields |
submissions:read | GET /submissions, GET /submissions/:id |
submissions:write | DELETE /submissions/:id, POST /submissions/:id/spam et /not-spam, et l'envoi vers /f/:formId |
webhooks:read | GET /webhooks, GET /webhooks/:endpointId et /deliveries |
webhooks:write | POST /webhooks et PATCH /webhooks/:endpointId (avec submissions:read), DELETE /webhooks/:endpointId, et POST vers /roll-secret, /test et /replay |
Une clé conserve les portées avec lesquelles elle a été créée. Les clés existantes ne reçoivent pas forms:write, webhooks:read ni webhooks:write ; créez une nouvelle clé qui les inclut.
Authentification
Envoyez la clé secrète comme token Bearer. L'API fonctionne uniquement de serveur à serveur : elle n'envoie aucun en-tête CORS et répond aux preflights des navigateurs avec 405, donc une clé secrète ne peut jamais fonctionner depuis une page web.
curl https://ikiform.com/api/v1/forms \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"- Une clé absente, mal formée, inconnue, révoquée ou expirée reçoit
401 unauthorizedavecWWW-Authenticate: Bearer. - Une clé publiable reçoit
403 forbidden(Publishable keys can only submit forms.). Une clé sans la portée nécessaire reçoit403 forbiddenavec le nom de la portée dans le message. - Les réponses sont envoyées avec
Cache-Control: no-store.
Les exemples SDK ci-dessous partagent un même client :
import { createClient } from "@ikiform/sdk";
const ikiform = createClient({ apiKey: process.env.IKIFORM_SECRET_KEY! });Compositeur de requête
curl "https://ikiform.com/api/v1/submissions?form_id=frm_xxxxxxxxxxxxxxxx&status=received&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Exécutez ceci depuis votre serveur. L'API REST refuse les requêtes venant du navigateur, donc cette page ne l'envoie jamais.
Endpoints
| Méthode | Chemin | Portée | Renvoie |
|---|---|---|---|
GET | /me | any | Vérifier une clé d'API |
GET | /forms | forms:read | Lister les formulaires |
GET | /forms/:formId | forms:read | Récupérer un formulaire |
POST | /forms | forms:write | Créez un formulaire |
PATCH | /forms/:formId | forms:write | Mettre à jour un formulaire |
PUT | /forms/:formId/fields | forms:write | Publier un schéma de champs |
DELETE | /forms/:formId/fields | forms:write | Supprimer le schéma de champs |
DELETE | /forms/:formId | forms:write | Supprimer un formulaire |
GET | /submissions | submissions:read | Lister les soumissions |
GET | /submissions/:id | submissions:read | Récupérer une soumission |
POST | /submissions/:id/spam | submissions:write | Marquer comme spam |
POST | /submissions/:id/not-spam | submissions:write | Marquer comme légitime |
DELETE | /submissions/:id | submissions:write | Supprimer une soumission |
GET | /forms/:formId/fields | forms:read | Lister les champs d'un formulaire |
GET | /forms/:formId/sample | submissions:read | Exemples d'événements de soumission |
GET | /webhooks | webhooks:read | Lister les endpoints de webhook |
POST | /webhooks | webhooks:write | Créer un endpoint de webhook |
GET | /webhooks/:endpointId | webhooks:read | Récupérer un endpoint de webhook |
PATCH | /webhooks/:endpointId | webhooks:write | Mettre à jour un endpoint de webhook |
POST | /webhooks/:endpointId/roll-secret | webhooks:write | Renouveler le secret de signature |
DELETE | /webhooks/:endpointId | webhooks:write | Supprimer un endpoint de webhook |
POST | /hooks | webhooks:write | S'abonner à un REST hook |
DELETE | /hooks/:hookId | webhooks:write | Se désabonner d'un REST hook |
GET | /webhooks/:endpointId/deliveries | webhooks:read | Lister les livraisons |
POST | /webhooks/:endpointId/test | webhooks:write | Envoyer un événement de test |
POST | /webhooks/:endpointId/replay | webhooks:write | Rejouer les livraisons échouées |
GET | /openapi.json | Aucun | Le document OpenAPI |
GET | /health | Aucun | { "ok": true } |
Vérifier une clé d'API
GET /me avec n'importe quelle portée.
- Fonctionne avec n'importe quelle portée. Les plateformes d'automatisation l'appellent pour tester une connexion et la nommer d'après le workspace.
curl https://ikiform.com/api/v1/me \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Lister les formulaires
GET /forms avec la portée forms:read.
- Les plus récents en premier. Accepte
limit(1 à 100, 25 par défaut) etcursor.
curl "https://ikiform.com/api/v1/forms?limit=10" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Récupérer un formulaire
GET /forms/:formId avec la portée forms:read.
- Renvoie aussi
fieldsetdefinition, le schéma de champs publié, ounullquand le formulaire n'en a pas et accepte n'importe quels champs, ainsi que l'état desnotifications(activées ou non).
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Créez un formulaire
POST /forms avec la portée forms:write.
- Seul
nameest obligatoire. Envoyez du JSON avecContent-Type: application/json. - Envoyez les soumissions vers l'
endpointrenvoyé. Ajoutez un champ masqué nomméhoneypot_fieldet laissez-le vide. - Il accepte aussi tous les réglages de Mettre à jour un formulaire, sauf
status.
curl -X POST https://ikiform.com/api/v1/forms \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "Waitlist", "allowed_domains": ["example.com"], "redirect_url": "https://example.com/thanks" }'Mettre à jour un formulaire
PATCH /forms/:formId avec la portée forms:write.
- N'envoyez que ce qui change.
statusvautactiveoupaused; un formulaire en pause refuse les envois. Un formulaire désactivé par Ikiform renvoie403. - Envoyez
[]ounullpour viderallowed_domainsouredirect_url, etnullcommehoneypot_fieldpour revenir à_gotcha. spam_checkvautoff,ikiform(notre vérification humaine) oucustom(votre widget Turnstile, avecturnstile_site_keyetturnstile_secret). Le secret est stocké chiffré et n'est jamais renvoyé ;nullle supprime et désactivecustom.origin_mismatchvautspamourejectpour les envois depuis des sites hors deallowed_domains.rate_limitacceptepreset(standard,relaxed,strictoucustom), ainsi queper_ip,window_seconds(10, 60, 600, 3600 ou 86400) etper_form_per_minute(facultatif) pourcustom. Il est en écriture seule, donc les bots ne peuvent pas le lire.notifications: { "enabled": false }arrête les e-mails de nouvelle soumission. Les destinataires se choisissent dans le tableau de bord.- Les champs inconnus renvoient
400 invalid_requesten nommant le champ.
curl -X PATCH https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "paused", "origin_mismatch": "reject", "rate_limit": { "preset": "strict" } }'Publier un schéma de champs
PUT /forms/:formId/fields avec la portée forms:write.
- Le corps est une définition de formulaire :
version1, untitleet jusqu'à 100fields, au même format que Champs. Il peut atteindre 256 Ko. - À partir de là, les envois sont validés par rapport à lui et ceux qui ne correspondent pas sont rejetés avec
422. Une définition qui pose problème renvoie422 validation_failed, eterror.fieldsles liste par chemin, commefields.0.type.
curl -X PUT https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "version": 1, "title": "Contact", "fields": [{ "id": "email", "type": "email", "label": "Email", "required": true }, { "id": "message", "type": "textarea", "label": "Message" }] }'Supprimer le schéma de champs
DELETE /forms/:formId/fields avec la portée forms:write.
- Le formulaire accepte de nouveau n'importe quels champs.
curl -X DELETE https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Supprimer un formulaire
DELETE /forms/:formId avec la portée forms:write.
- L'endpoint cesse aussitôt d'accepter les envois, et le formulaire disparaît des listes. Supprimer de nouveau renvoie
404.
curl -X DELETE https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Lister les soumissions
GET /submissions avec la portée submissions:read.
| Paramètre | Valeurs | Par défaut |
|---|---|---|
form_id | Un id de formulaire | Tous les formulaires de l'espace de travail |
status | received ou spam | Les deux |
limit | 1 à 100 | 25 |
cursor | next_cursor de la page précédente | La première page |
- Les plus récentes en premier. Un
form_idd'un autre espace de travail renvoie une liste vide plutôt qu'une erreur, pour que les ids ne puissent pas être sondés.
curl "https://ikiform.com/api/v1/submissions?form_id=frm_xxxxxxxxxxxxxxxx&status=received&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Récupérer une soumission
GET /submissions/:id avec la portée submissions:read.
curl https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Marquer comme spam
POST /submissions/:id/spam avec la portée submissions:write.
- Déplace une soumission reçue vers le spam, diminue le
submission_countdu formulaire, annule ses livraisonssubmission.createden attente et envoiesubmission.updatedaux endpoints abonnés. - L'appeler sur une soumission déjà marquée comme spam la renvoie inchangée.
curl -X POST https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3/spam \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Marquer comme légitime
POST /submissions/:id/not-spam avec la portée submissions:write.
- La replace parmi les reçues, efface son score et ses raisons de spam, et envoie
submission.updatedaux endpoints abonnés, ainsi quesubmission.createdaux endpoints abonnés qui n'en ont jamais reçu pour elle. - L'appeler sur une soumission reçue la renvoie inchangée.
curl -X POST https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3/not-spam \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Supprimer une soumission
DELETE /submissions/:id avec la portée submissions:write.
- Supprime définitivement la soumission et ses livraisons de webhook, puis envoie
submission.deletedaux endpoints abonnés. Impossible d'annuler. Une nouvelle suppression renvoie404.
curl -X DELETE https://ikiform.com/api/v1/submissions/sub_01k7v2c9t3e8m5q4x6z0a1b2c3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Lister les champs d'un formulaire
GET /forms/:formId/fields avec la portée forms:read.
- Liste les champs qu'une soumission peut contenir, pour le mappage dans Zapier, Make ou n8n.
keyest le nom que la valeur a dansfields. sourcevautdefinitionlorsque le formulaire a des champs publiés. Sinon, la liste est construite à partir des clés de ses 25 soumissions les plus récentes, sans les clés réservées commençant par_.
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/fields \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Exemples d'événements de soumission
GET /forms/:formId/sample avec la portée submissions:read.
- Renvoie jusqu'à 3 soumissions reçues récemment, exactement dans le corps qu'un webhook
submission.createdtransporte, afin qu'un outil puisse afficher de vraies données pendant la configuration. - Un formulaire sans soumission reçoit un exemple construit à partir de ses champs, avec
submission_iddéfini sursub_example.
curl https://ikiform.com/api/v1/forms/frm_xxxxxxxxxxxxxxxx/sample \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Lister les endpoints de webhook
GET /webhooks avec la portée webhooks:read.
- Renvoie tous les endpoints de l'espace de travail en une seule page.
- Les secrets de signature et les valeurs des en-têtes personnalisés ne sont jamais renvoyés.
header_namesliste les en-têtes personnalisés que porte chaque livraison.
curl https://ikiform.com/api/v1/webhooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Créer un endpoint de webhook
POST /webhooks avec la portée webhooks:write.
urlsuit les règles d'URL des endpoints. Omettezform_idpour tous les formulaires.event_typesvautsubmission.createdpar défaut.headersest une liste de{ name, value }, stockée chiffrée ; voir En-têtes personnalisés.secretn'est renvoyé qu'ici, conservez-le donc dès maintenant. Au-delà de la limite d'endpoints de votre offre, vous obtenez402 plan_required.- Créer ou modifier un endpoint demande aussi
submissions:read, car l’endpoint reçoit les données des soumissions.
curl -X POST https://ikiform.com/api/v1/webhooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com/webhooks/ikiform", "form_id": "frm_xxxxxxxxxxxxxxxx", "headers": [{ "name": "Authorization", "value": "Bearer your-token" }] }'Récupérer un endpoint de webhook
GET /webhooks/:endpointId avec la portée webhooks:read.
curl https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Mettre à jour un endpoint de webhook
PATCH /webhooks/:endpointId avec la portée webhooks:write.
- N'envoyez que ce qui change :
url,form_id,description,event_types,headersoustatus. status: "disabled"arrête les livraisons et"active"les reprend. La reprise n'envoie pas ce qui a été manqué : rejouez-le.headersremplace la liste enregistrée ;"value": nullconserve une valeur enregistrée. Quandurlchange, renvoyez toutes les valeurs pour qu'un jeton n'arrive jamais par erreur chez un nouvel hôte.
curl -X PATCH https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "disabled" }'Renouveler le secret de signature
POST /webhooks/:endpointId/roll-secret avec la portée webhooks:write.
- Renvoie une seule fois un nouveau secret de signature. L'ancien continue de fonctionner pendant 24 heures, ce qui vous permet de mettre à jour votre serveur sans perdre de livraisons.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/roll-secret \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Supprimer un endpoint de webhook
DELETE /webhooks/:endpointId avec la portée webhooks:write.
- Supprime l'endpoint et son historique de livraisons. Les livraisons en attente vers lui sont abandonnées.
curl -X DELETE https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"S'abonner à un REST hook
POST /hooks avec la portée webhooks:write.
- Crée un endpoint de webhook pour une plateforme d'automatisation. Il accepte les mêmes champs que Créer un endpoint de webhook, plus
managed_by:zapier,make,n8nouautomation(par défaut). - C'est un endpoint normal : il compte dans la limite d'endpoints de votre offre, apparaît dans le tableau de bord et est signé. Lorsque son récepteur répond
410 Gone, il est supprimé sans l'e-mail habituel, car la plateforme l'a désactivé. - Nécessite aussi
submissions:read, car le hook reçoit des données de soumission.
curl -X POST https://ikiform.com/api/v1/hooks \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://hooks.zapier.com/hooks/standard/123/abc", "form_id": "frm_xxxxxxxxxxxxxxxx", "managed_by": "zapier" }'Se désabonner d'un REST hook
DELETE /hooks/:hookId avec la portée webhooks:write.
- Supprime le hook et son historique de livraisons, comme Supprimer un endpoint de webhook.
curl -X DELETE https://ikiform.com/api/v1/hooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3 \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Lister les livraisons
GET /webhooks/:endpointId/deliveries avec la portée webhooks:read.
- Les plus récentes d'abord.
statusvautsucceeded,pendingoufailed;failedinclut les livraisons annulées. Acceptelimitetcursorcomme les autres listes. last_status_codeetlast_errorproviennent de la dernière tentative.
curl "https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/deliveries?status=failed&limit=50" \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Envoyer un événement de test
POST /webhooks/:endpointId/test avec la portée webhooks:write.
- Met en file un événement
endpoint.testet renvoie la livraison. Listez les livraisons pour voir comment votre serveur a répondu. - Un endpoint désactivé renvoie
409 conflict. Activez-le d'abord.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/test \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY"Rejouer les livraisons échouées
POST /webhooks/:endpointId/replay avec la portée webhooks:write.
windowvaut24h,3dou7d. Chaque livraison créée dans cette fenêtre qui a échoué ou a été annulée est renvoyée en une minute environ, jusqu'à 1 000 par appel.- Si
morevauttrue, appelez de nouveau pour rejouer le reste. - Un endpoint désactivé renvoie
409 conflict. Les événements de test ne sont jamais rejoués. Voir Rejouer les livraisons échouées.
curl -X POST https://ikiform.com/api/v1/webhooks/whk_01k7v2b8f4h6j2k9m3n5p7q1r3/replay \
-H "Authorization: Bearer $IKIFORM_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "window": "24h" }'Objets
Les objets sont du JSON en snake_case avec un champ object. Les horodatages sont en ISO 8601 UTC avec millisecondes. Les ids de soumission, d'endpoint et de livraison sont ordonnés dans le temps (sub_, whk_ et dlv_ plus 26 caractères) ; les ids de formulaire sont aléatoires (frm_ plus 16 caractères).
| Champ du formulaire | Description |
|---|---|
status | active, paused ou disabled |
submission_count | Soumissions reçues, hors spam |
endpoint | L'URL vers laquelle envoyer les soumissions |
honeypot_field | Le champ masqué que remplissent les bots. Laissez-le vide dans votre formulaire |
allowed_domains | Sites autorisés à envoyer, sous-domaines inclus. Vide autorise tous les sites |
redirect_url | Où vont les navigateurs après un envoi HTML simple, ou null pour la page de remerciement d'Ikiform |
spam_check | off, ikiform ou custom, avec turnstile_site_key et turnstile_secret_set pour custom |
origin_mismatch | spam ou reject : ce qui arrive aux envois depuis des sites hors de allowed_domains |
fields, definition, notifications | Uniquement lors de la lecture, de la création ou de la mise à jour d'un formulaire. Le schéma de champs, ou null s'il n'y en a pas, et si les nouvelles soumissions sont envoyées par e-mail |
| Champ de l'endpoint de webhook | Description |
|---|---|
form_id | Le seul formulaire dont il reçoit les événements, ou null pour tous les formulaires |
status | active ou disabled, avec disabled_reason quand il est désactivé |
event_types | Les événements auxquels il est abonné |
header_names | En-têtes personnalisés envoyés avec chaque livraison. Les valeurs ne sont jamais renvoyées |
failing_since, consecutive_failures, circuit_open_until | Suivi des échecs. Après des échecs répétés, les livraisons sont suspendues jusqu'à circuit_open_until |
| Champ de la livraison | Description |
|---|---|
status | pending, succeeded, failed or cancelled |
attempt_count | Tentatives jusqu'ici |
last_status_code, last_error | Le code de statut de votre serveur, ou l'erreur, de la dernière tentative |
next_attempt_at | Moment de la prochaine tentative d'une livraison en attente |
| Champ de la soumission | Description |
|---|---|
status | received ou spam |
fields | Les valeurs stockées |
meta | user_agent, origin, referrer, country, subject, reply_to. Chaque clé est présente et n'importe quelle valeur peut être null. Le hachage de l'IP n'est jamais renvoyé |
spam.score, spam.reasons | Le score et les raisons de spam, comme honeypot ou origin_mismatch |
Pagination
Les listes commencent par les plus récents et utilisent des curseurs opaques.
- Faites une requête sans curseur.
- Si
has_morevaut true, envoyeznext_cursordanscursoravec les mêmes filtres. - Arrêtez quand
next_cursorvautnull.
Les pages restent stables pendant l'arrivée de nouvelles soumissions : les nouvelles apparaissent sur la première page, jamais en double plus loin. Ne construisez pas et n'analysez pas les curseurs vous-même ; un curseur invalide renvoie 400 invalid_request.
for await (const submission of ikiform.submissions.iterate({ formId: "frm_xxxxxxxxxxxxxxxx" })) {
console.log(submission.id, submission.fields);
}Erreurs
Les erreurs utilisent la même enveloppe que les soumissions de formulaire. Chaque réponse a un en-tête X-Request-Id, que les erreurs reprennent en request_id.
{
"ok": false,
"error": { "code": "forbidden", "message": "This API key is missing the forms:read scope." },
"request_id": "req_01k7v2c9t3e8m5q4x6z0a1b2c3"
}| Statut | Code | Quand |
|---|---|---|
| 400 | invalid_request | Un paramètre de requête ou un champ du corps est invalide ; le message le nomme, et error.fields associe un champ du corps à ses messages |
| 400 | invalid_body | Le corps n'est pas un objet JSON |
| 401 | unauthorized | Clé absente ou invalide |
| 402 | plan_required | Création d'un endpoint de webhook au-delà du nombre inclus dans votre offre |
| 403 | forbidden | Clé publiable, portée manquante, ou reprise d'un formulaire désactivé par Ikiform |
| 404 | not_found | Route ou id inconnu, ou id d'un autre espace de travail, exactement comme un id qui n'existe pas |
| 405 | method_not_allowed | Un preflight de navigateur |
| 409 | conflict | Test ou relecture d'un endpoint de webhook désactivé |
| 413 | payload_too_large | Le corps dépasse 16 Ko, ou 256 Ko pour un schéma de champs |
| 415 | unsupported_media_type | Le corps n'est pas envoyé en application/json |
| 422 | validation_failed | Un schéma de champs pose problème ; error.fields les liste par chemin |
| 429 | rate_limited | Limite de débit par clé dépassée |
| 500 | server_error | Une erreur de notre côté ; indiquez le request_id |
Limite de débit
Chaque clé peut faire 100 requêtes par tranche de 60 secondes. Au-delà, l'API renvoie 429 rate_limited avec un en-tête Retry-After en secondes. Le SDK l'expose dans error.retryAfter.
Tableau de bord uniquement
Les clés API, les membres et invitations, les destinataires des notifications et la facturation se gèrent uniquement dans le tableau de bord. Une clé qui fuite ne peut pas créer d'autres clés, inviter quelqu'un dans votre espace de travail, envoyer des e-mails à de nouvelles adresses ni dépenser de l'argent.