API REST : principes et limites

Adresse, authentification, format des réponses, erreurs et limites de l’API.

À quoi ça sert

Créer des formulaires, envoyer des liens, lire les réponses et remplir des PDF depuis vos propres outils.

Prérequis et forfait

Une clé d’API (voir « Clés d’API »). Les quotas du forfait s’appliquent.

Étapes

1. Créez une clé dans « Paramètres » → « Clés d’API ».
2. Envoyez vos requêtes à l’adresse indiquée sous « Clés d’API » (…/api.php?r=ressource) avec l’en-tête Authorization: Bearer fm_…
3. Les ressources (paramètre r) sont : templates, usage, forms, form, pdf, send, sends, models, model, fill, hooks, hook, hook_test.
4. Testez avec GET r=usage : il renvoie votre forfait, votre usage du mois et un lien pour passer à Pro.
5. Lisez le tableau de référence de la page d’aide, section « API REST ».

curl -X POST 'https://VOTRE-ADRESSE/api.php?r=forms' \
  -H 'Authorization: Bearer fm_…' -H 'Content-Type: application/json' \
  -d '{"title":"Évaluation initiale","template":"moderne","questions":[
        {"label":"Nom complet","type":"text","required":true},
        {"label":"Situation","type":"radio","options":["Étudiant","Travailleur"]}]}'

Résultat attendu

Réponses JSON UTF-8. Succès : 200 (ou 201 pour une création). Erreurs : 401 clé invalide, 402 quota dépassé, 404 introuvable, 405 méthode non permise, 422 données invalides, 429 trop de requêtes.

Astuces

• Limite : 600 requêtes par 15 minutes par clé (au-delà : 429 « Trop de requêtes. »).
• Au dépassement de quota, l’API répond 402 avec "code":"quota_exceeded", la limite, l’usage et un "upgrade_url" signé valide 7 jours.

Problèmes fréquents

402 quota_exceeded

Votre forfait est à sa limite : suivez upgrade_url ou attendez le mois suivant.

422 avec un message d’erreur

Les données envoyées sont invalides (ex. « Type de question inconnu », « Modèle inconnu »).

429 Trop de requêtes.

Espacez vos appels ; la limite se libère après 15 minutes.

Pages concernées

Référence de l’API Paramètres

Ces pages demandent d’être connecté.

Articles liés