Passer au contenu

Python

Appelez Formerie à partir de n’importe quel serveur Python avec requests, le client que la plupart des projets ont déjà. Vous n’avez besoin ni d’un paquet Formerie ni d’une clé d’API : l’adresse publique d’un formulaire suffit.

Soumettre un formulaire

Installez requests, enregistrez ce code sous submit.py, puis lancez python submit.py.

Shell
pip install requests
Python
import os

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")

response = requests.post(
    f"{RUNTIME_URL}/{FORM}/submit",
    json={
        "fields": {
            "name": "Jane Example",
            "email": "jane@example.com",
            "message": "Hello from my server",
        },
    },
    timeout=10,
)
result = response.json()
print(response.status_code, result["submissionUid"] if result["ok"] else result["error"]["code"])

Remplacez acme/contact, sur la ligne indiquée, par vos propres identifiants. Une réussite donne l’état HTTP 202, avec un submissionUid comme sub_p6dr8wq2j7tkan : les réponses sont stockées et leur courriel est en file d’attente. Chaque exemple lit deux réglages facultatifs dans l’environnement : FORMERIE_RUNTIME_URL pour un nom d’hôte que vous avez branché, et FORMERIE_FORM pour les identifiants.

Avant de commencer

  1. Publiez un formulaire, et prenez ses identifiants d’espace de travail et de formulaire dans l’onglet Publication. Votre serveur n’a pas besoin de figurer dans les sites autorisés du formulaire.
  2. Pour faire des essais sans envoyer de courriel, créez une clé de test dans l’onglet Tests du formulaire, et mettez-la dans une variable d’environnement appelée FORMERIE_TEST_KEY :
Python
import os

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")

response = requests.post(
    f"{RUNTIME_URL}/{FORM}/submit",
    # Keep the key out of your code. A test is stored apart and emails nobody.
    headers={"X-Formerie-Test-Key": os.environ["FORMERIE_TEST_KEY"]},
    json={"fields": {"name": "Jane Example", "email": "jane@example.com", "message": "Just a test"}},
    timeout=10,
)
result = response.json()
print(response.status_code, result["submissionUid"] if result["ok"] else result["error"]["code"])

Un test revient sous la forme tst_..., est stocké à part et n’envoie de courriel à personne. Une mauvaise clé reçoit TEST_KEY_INVALID, état HTTP 401, et rien n’est stocké. Retirez l’en-tête avant la mise en ligne, car une clé laissée en place classe tout comme un test. Consultez Tester depuis un serveur ou l’intégration continue.

Vérifier des réponses sans soumettre

validate vérifie les réponses et ne stocke rien, ce qui vous permet de signaler un problème tôt. Il répond 200 quand elles passent, et 422 avec les mêmes erreurs qu’une soumission quand elles ne passent pas. La soumission finale vérifie toujours tout le formulaire de nouveau.

Python
import os

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")


def check_answers(fields, step=None):
    """Checks answers and stores nothing. Without a step, only the fields you send are checked."""
    body = {"mode": "step", "step": step, "fields": fields} if step else {"mode": "partial", "fields": fields}
    response = requests.post(f"{RUNTIME_URL}/{FORM}/validate", json=body, timeout=10)
    result = response.json()
    if result["ok"]:
        return {"valid": True, "values": result["values"]}
    if result["error"]["code"] != "VALIDATION_FAILED":
        raise RuntimeError(result["error"]["code"])
    return {"valid": False, "fields": result["error"]["fields"]}

Par défaut, seuls les champs que vous envoyez sont vérifiés. Passez une étape pour vérifier plutôt tous ses champs, sur un formulaire à étapes. Une étape que le formulaire n’a pas reçoit BAD_REQUEST.

Afficher les erreurs par champ

Les réponses refusées reviennent avec VALIDATION_FAILED, état HTTP 422, et rien n’est stocké. error.fields contient les problèmes par champ, et error.issues les mêmes, dans l’ordre. Chacun a un path, un code sur lequel vous fier et un message que vous pouvez afficher, dans la langue du formulaire.

Python
import html
import os

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")


def submit_answers(fields):
    response = requests.post(f"{RUNTIME_URL}/{FORM}/submit", json={"fields": fields}, timeout=10)
    return response.json()


def field_errors(result):
    """The messages for each field, by path, such as message or contact.email."""
    if result["ok"] or result["error"]["code"] != "VALIDATION_FAILED":
        return {}
    return {path: [issue["message"] for issue in issues] for path, issues in result["error"]["fields"].items()}


def answer_at(answers, path):
    """Finds the visitor's answer for a path, so the form can show it again."""
    value = answers
    for part in path.split("."):
        value = value.get(part, "") if isinstance(value, dict) else ""
    return value


def render_field(path, answers, errors):
    """One input with its answer kept and its first message under it."""
    name = html.escape(path)
    value = html.escape(str(answer_at(answers, path)))
    error = f'<p class="error">{html.escape(errors[path][0])}</p>' if path in errors else ""
    return f'<input name="{name}" value="{value}">{error}'

Un champ dans un groupe a un chemin comme contact.email, et un champ dans une liste, guests[0].email : séparez le chemin pour trouver sa réponse. Consultez Chemins de champs. Réaffichez les réponses du visiteur avec les messages, échappées, pour qu’il n’ait qu’à corriger ce qui ne va pas.

Réessayer en toute sécurité

Une panne de réseau ne vous dit pas si la soumission est arrivée. Envoyez donc une seule metadata.idempotencyKey par soumission, la même à chaque nouvel essai. Formerie la compte et la livre alors une seule fois, et signale une répétition avec DUPLICATE_SUBMISSION, état HTTP 409, qui veut dire que le premier envoi a fonctionné.

Python
import os
import random
import time
import uuid

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")
MAX_ATTEMPTS = 3
LONGEST_WAIT = 30
TEMPORARY_CODES = {"FORM_MAINTENANCE", "QUEUE_FAILED", "INTERNAL_ERROR"}


def retry_after(response):
    value = response.headers.get("Retry-After", "")
    return int(value) if value.isdigit() else None


def send_once(fields, key):
    """One attempt. Says what happened, and whether another attempt could help."""
    try:
        response = requests.post(
            f"{RUNTIME_URL}/{FORM}/submit",
            json={"fields": fields, "metadata": {"idempotencyKey": key}},
            timeout=10,
        )
    except requests.RequestException:
        return {"outcome": "retry-later", "reason": "network", "again": True}

    after = retry_after(response)
    # Only the short-term limit sends Retry-After. A form's own limit can last an hour, so don't wait for it.
    if response.status_code == 429:
        return {"outcome": "retry-later", "reason": "rate-limited", "after": after,
                "again": after is not None and after <= LONGEST_WAIT}

    # Something in front of Formerie may answer without JSON, so look at the status first.
    try:
        result = response.json()
    except ValueError:
        return {"outcome": "retry-later", "reason": "bad-response", "again": response.status_code in (502, 503, 504)}

    if result["ok"]:
        return {"outcome": "accepted", "id": result["submissionUid"]}
    error = result["error"]
    if error["code"] == "DUPLICATE_SUBMISSION":
        # The first send worked, and only its answer was lost.
        return {"outcome": "accepted", "duplicate": True}
    if error["code"] in TEMPORARY_CODES:
        return {"outcome": "retry-later", "reason": error["code"], "again": True}
    if error["code"] == "VALIDATION_FAILED":
        return {"outcome": "invalid", "code": error["code"], "issues": error["issues"]}
    return {"outcome": "rejected", "code": error["code"], "message": error["message"]}


def submit_with_retries(fields, key=None):
    # One key per submission, the same on every retry. Store it with the answers if you retry later.
    key = key or str(uuid.uuid4())
    for attempt in range(1, MAX_ATTEMPTS + 1):
        answer = send_once(fields, key)
        if not answer.pop("again", False) or attempt == MAX_ATTEMPTS:
            return {**answer, "key": key, "attempts": attempt}
        backoff = random.uniform(0, min(0.25 * 2 ** attempt, 4))
        time.sleep(max(answer.get("after") or 0, backoff))
RéponseRéessayer?
Pas de connexion, ou délai dépasséOui, avec la même clé
429 avec Retry-AfterOui, après cette attente, si elle est courte. La limite à court terme répond avec Retry-After: 60
429 sans Retry-AfterNon. La limite d’un formulaire peut durer une heure : demandez au visiteur de réessayer plus tard
FORM_MAINTENANCE, QUEUE_FAILED, INTERNAL_ERROROui, après une courte attente
502, 503 ou 504 sans JSONOui. Quelque chose devant Formerie a répondu
Toute autre réponse sans JSONNon. Gardez la clé, et voyez ce qui s’est passé
DUPLICATE_SUBMISSIONNon. Traitez-le comme un succès
VALIDATION_FAILED et tout autre codeNon. La réponse ne changera pas
  • La clé doit être une chaîne non vide. Tout le reste est ignoré, et il n’y a alors aucune vérification des répétitions.
  • Une répétition est repérée pendant 300 secondes par défaut, selon la période d’envois répétés du formulaire. Consultez Ce que couvre la période d’envois répétés.
  • Cette vérification passe en premier : une clé déjà acceptée reçoit DUPLICATE_SUBMISSION, même avec d’autres réponses. Utilisez une nouvelle clé pour chaque nouvelle soumission. Une clé refusée à cause de ses réponses n’a jamais été acceptée : elle peut repartir une fois celles-ci corrigées.
  • Un nouvel essai après QUEUE_FAILED peut stocker une deuxième copie, que vous verriez sous Soumissions. C’est rare.

Vérification humaine

Si votre formulaire exige une vérification humaine, utilisez vos propres clés, avec votre site dans la liste de domaines du fournisseur et dans les sites autorisés du formulaire. Le widget ajoute son jeton à votre formulaire. Transmettez deux choses :

  1. Le jeton, comme verificationToken, retiré des champs.
  2. L’Origin de la requête du visiteur, parce que Formerie compare le domaine du jeton avec celui-ci. Un serveur n’en envoie pas de lui-même, et la vérification échoue alors avec TURNSTILE_FAILED.
Python
import os

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")


def submit_verified(posted, origin):
    """posted is what your form sent. origin is the Origin header of the visitor's request."""
    fields = dict(posted)
    token = fields.pop("cf-turnstile-response", "")
    # Without the visitor's Origin, the provider's hostname can't match, and the check fails.
    headers = {"Origin": origin} if origin else {}
    response = requests.post(
        f"{RUNTIME_URL}/{FORM}/submit",
        headers=headers,
        json={"fields": fields, "verificationToken": token},
        timeout=10,
    )
    return response.json()

Une Origin absente des sites autorisés du formulaire reçoit FORBIDDEN_ORIGIN. Ne la transmettez que pour ça : sur tout autre formulaire, elle active une vérification dont votre serveur n’a autrement pas besoin. Le widget a besoin de JavaScript dans le navigateur du visiteur. Consultez La vérification avec un serveur.

Vérifications antipourriel

Les pages hébergées et les intégrations envoient ces métadonnées pour vous. À partir de votre serveur, envoyez-les vous-même, sinon ces vérifications sont sautées.

Python
import os
import uuid
from datetime import datetime, timedelta, timezone

import requests

RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORM = os.environ.get("FORMERIE_FORM", "acme/contact")


def submit_with_metadata(fields, started_at, visitor_id):
    response = requests.post(
        f"{RUNTIME_URL}/{FORM}/submit",
        json={
            "fields": fields,
            "metadata": {
                "idempotencyKey": str(uuid.uuid4()),
                # When the visitor opened the form, for the minimum submit time check.
                "startedAt": started_at.isoformat().replace("+00:00", "Z"),
                "pageUrl": "https://www.example.com/contact",
                # Your own visitor ID, for a limit rule with the deviceToken scope.
                "deviceToken": visitor_id,
            },
        },
        timeout=10,
    )
    return response.status_code, response.json()
ChampÀ quoi il sert
idempotencyKeyLa vérification des répétitions, comme ci-dessus
startedAtLe moment où le visiteur a ouvert le formulaire, en heure ISO 8601. Envoyé avant le minimum du formulaire, 1 seconde par défaut, il reçoit SPAM_REJECTED. Gardez la vraie heure à laquelle vous avez affiché le formulaire, pas celle de cet appel. Une valeur illisible saute la vérification
pageUrlLa page d’où le formulaire a été envoyé. Stockée seulement s’il s’agit d’une adresse http ou https
deviceTokenVotre propre identifiant de visiteur, pour une limite par visiteur, ci-dessous

La vérification du champ caché s’applique quand votre formulaire envoie ce champ, et les liens et la vérification humaine sont vérifiés sur le serveur dans tous les cas. Consultez Pourriel et limites.

Les limites à partir de votre serveur

Formerie compte les visiteurs par adresse réseau, et d’ici, c’est celle de votre serveur. Chaque visiteur compte comme votre serveur.

LimitePar défautÀ partir de votre serveur
Par visiteur30 soumissions toutes les 10 minutesPartagée par tous vos visiteurs. Augmentez-la avant le lancement, ou laissez-la vide pour n’avoir aucune limite, sous Paramètres, puis Limites de soumission
Tout le formulaire1 000 soumissions à l’heureLa même. Avec le forfait gratuit, c’est aussi le maximum qu’un formulaire peut accepter
Court terme120 requêtes à la minute pour chaque formulaire à partir d’une même adresseNe peut pas être changée. C’est la seule qui envoie Retry-After. validate y compte aussi

Au-delà de l’une d’elles, vous recevez RATE_LIMITED, état HTTP 429. Pour garder une limite par visiteur, une règle avec la portée deviceToken compte selon l’identifiant que vous envoyez, comme un hachage de l’adresse du visiteur. Les paramètres de l’application n’offrent pas encore cette règle, alors écrivez-nous pour en mettre une en place, et gardez la limite pour tout le formulaire, car quiconque appelle directement le formulaire peut changer son identifiant. Consultez Les limites avec un serveur pour le raisonnement, et Forfaits et limites pour les compteurs mensuels.

Django

Ça fonctionne par l’API : la vue lit le formulaire du visiteur et appelle Formerie avec requests. Le code a été exécuté avec un backend Formerie local et Django 6.1. Il répond 202 avec l’identifiant de la soumission, le même état que Formerie avec les messages par champ, ou 503 s’il ne peut pas joindre Formerie. Gardez la protection CSRF de Django, avec {% csrf_token %} dans votre formulaire.

Shell
pip install django requests
Python
import requests
from django.http import JsonResponse
from django.views.decorators.http import require_POST

FORMERIE_RUNTIME_URL = os.environ.get("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
# Your form. This is the only line that names it.
FORMERIE_FORM = os.environ.get("FORMERIE_FORM", "acme/contact")


@require_POST
def contact(request):
    # Name the fields you send, so a visitor can't add others.
    fields = {name: request.POST.get(name, "") for name in ("name", "email", "message")}
    try:
        answer = requests.post(f"{FORMERIE_RUNTIME_URL}/{FORMERIE_FORM}/submit", json={"fields": fields}, timeout=10)
        result = answer.json()
    except (requests.RequestException, ValueError):
        # No connection, a timeout, or an answer that isn't JSON. Keep the visitor's answers on screen.
        return JsonResponse({"code": "TRY_AGAIN"}, status=503)
    if result["ok"]:
        return JsonResponse({"id": result["submissionUid"]}, status=202)
    errors = {path: [issue["message"] for issue in issues] for path, issues in result["error"].get("fields", {}).items()}
    return JsonResponse({"code": result["error"]["code"], "errors": errors}, status=answer.status_code)

Bon à savoir

  • requests n’a aucun délai d’attente si vous n’en donnez pas : gardez timeout= sur chaque appel.
  • Gardez les clés de test et les réponses hors de vos journaux. Le requestId d’une erreur, ou l’en-tête X-Request-Id, est ce qu’il faut journaliser et citer quand vous demandez de l’aide.
  • Fiez-vous à error.code, jamais au message, car un formulaire peut reformuler ses messages et un même état peut couvrir plusieurs codes. Codes d’erreur les énumère tous.
AvecNote
FlaskLisez les réponses dans request.form, et l’Origin du visiteur dans request.headers. Django est ci-dessus.
FastAPIrequests est bloquant. Dans une route async def, utilisez httpx.AsyncClient, qui prend les mêmes json= et timeout=, ou une route def ordinaire.
httpxFonctionne de la même façon pour ces appels. Attrapez httpx.HTTPError au lieu de requests.RequestException.

Les routes, les champs et toutes les erreurs se trouvent dans la référence de l’API.