# Ruby

Appelez Formerie à partir de n’importe quel serveur Ruby avec `net/http`, de la bibliothèque standard, sans gem à installer. 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

Enregistrez ce code sous `submit.rb`, puis lancez `ruby submit.rb`.

```ruby
require "json"
require "net/http"

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

uri = URI("#{runtime_url}/#{form}/submit")
response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
  http.post(uri.path, JSON.generate(fields: {
    name: "Jane Example",
    email: "jane@example.com",
    message: "Hello from my server"
  }), "Content-Type" => "application/json")
end
result = JSON.parse(response.body)
puts "#{response.code} #{result["ok"] ? result["submissionUid"] : result.dig("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](/fr/guides/publish/), 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` :

```ruby
require "json"
require "net/http"

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

uri = URI("#{runtime_url}/#{form}/submit")
response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
  http.post(uri.path, JSON.generate(fields: {
    name: "Jane Example",
    email: "jane@example.com",
    message: "Just a test"
  }), {
    "Content-Type" => "application/json",
    # Keep the key out of your code. A test is stored apart and emails nobody.
    "X-Formerie-Test-Key" => ENV.fetch("FORMERIE_TEST_KEY")
  })
end
result = JSON.parse(response.body)
puts "#{response.code} #{result["ok"] ? result["submissionUid"] : result.dig("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](/fr/guides/test-your-form/#tester-depuis-un-serveur-ou-linté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.

```ruby
require "json"
require "net/http"

def post_json(action, payload)
  runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
  # Your form. This is the only line that names it.
  form = ENV.fetch("FORMERIE_FORM", "acme/contact")
  uri = URI("#{runtime_url}/#{form}/#{action}")
  Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
    http.post(uri.path, JSON.generate(payload), "Content-Type" => "application/json")
  end
end

# Checks answers and stores nothing. With no step, only the fields you send are checked.
def check_answers(fields, step: nil)
  payload = step ? { mode: "step", step: step, fields: fields } : { mode: "partial", fields: fields }
  result = JSON.parse(post_json("validate", payload).body)
  return result if result["ok"] || result.dig("error", "code") == "VALIDATION_FAILED"

  raise result.dig("error", "code")
end
```

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](/fr/guides/multi-step-forms/). 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.

```ruby
require "erb"
require "json"
require "net/http"

def submit_answers(fields)
  runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
  # Your form. This is the only line that names it.
  form = ENV.fetch("FORMERIE_FORM", "acme/contact")
  uri = URI("#{runtime_url}/#{form}/submit")
  response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
    http.post(uri.path, JSON.generate(fields: fields), "Content-Type" => "application/json")
  end
  JSON.parse(response.body)
end

# Finds the visitor's answer for a path such as contact.email, so the form can show it again.
def answer_at(answers, path)
  path.split(".").reduce(answers) { |value, part| value.is_a?(Hash) ? value[part] : nil }.to_s
end

# One input with its answer kept and its first message under it.
def render_field(path, answers, result)
  message = result.dig("error", "fields", path, 0, "message")
  error = message ? %(<p class="error">#{ERB::Util.html_escape(message)}</p>) : ""
  %(<input name="#{ERB::Util.html_escape(path)}" value="#{ERB::Util.html_escape(answer_at(answers, path))}">#{error})
end
```

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](/fr/guides/validation/#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é.

```ruby
require "json"
require "net/http"
require "securerandom"

MAX_ATTEMPTS = 3
LONGEST_WAIT = 30
TEMPORARY_CODES = %w[FORM_MAINTENANCE QUEUE_FAILED INTERNAL_ERROR].freeze

# One attempt. Says what happened, and whether another attempt could help.
def send_once(fields, key)
  runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
  # Your form. This is the only line that names it.
  form = ENV.fetch("FORMERIE_FORM", "acme/contact")
  uri = URI("#{runtime_url}/#{form}/submit")
  body = JSON.generate(fields: fields, metadata: { idempotencyKey: key })

  begin
    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
      # net/http retries some requests by itself, and this loop does that with a wait.
      http.max_retries = 0
      http.post(uri.path, body, "Content-Type" => "application/json")
    end
  rescue SystemCallError, SocketError, IOError, Timeout::Error, OpenSSL::SSL::SSLError
    return { outcome: "retry-later", reason: "network", again: true }
  end
  status = response.code.to_i

  # Only the short-term limit sends Retry-After. A form's own limit can last an hour, so don't wait for it.
  if status == 429
    after = response["Retry-After"]&.match?(/\A\d+\z/) ? response["Retry-After"].to_i : nil
    return { outcome: "retry-later", reason: "rate-limited", after: after, again: !after.nil? && after <= LONGEST_WAIT }
  end

  # Something in front of Formerie may answer without JSON, so look at the status first.
  begin
    result = JSON.parse(response.body)
  rescue JSON::ParserError
    return { outcome: "retry-later", reason: "bad-response", again: [502, 503, 504].include?(status) }
  end

  return { outcome: "accepted", id: result["submissionUid"] } if result["ok"]

  error = result["error"]
  case error["code"]
  when "DUPLICATE_SUBMISSION"
    # The first send worked, and only its answer was lost.
    { outcome: "accepted", duplicate: true }
  when *TEMPORARY_CODES
    { outcome: "retry-later", reason: error["code"], again: true }
  when "VALIDATION_FAILED"
    { outcome: "invalid", code: error["code"], issues: error["issues"] }
  else
    { outcome: "rejected", code: error["code"], message: error["message"] }
  end
end

# One key per submission, the same on every retry. Store it with the answers if you retry later.
def submit_with_retries(fields, key = SecureRandom.uuid)
  (1..MAX_ATTEMPTS).each do |attempt|
    answer = send_once(fields, key)
    again = answer.delete(:again)
    return answer.merge(key: key, attempts: attempt) if !again || attempt == MAX_ATTEMPTS

    backoff = rand * [0.25 * (2**attempt), 4].min
    sleep [answer[:after] || 0, backoff].max
  end
end
```

| Réponse | Réessayer? |
| --- | --- |
| Pas de connexion, ou délai dépassé | Oui, avec la même clé |
| `429` avec `Retry-After` | Oui, après cette attente, si elle est courte. La limite à court terme répond avec `Retry-After: 60` |
| `429` sans `Retry-After` | Non. La limite d’un formulaire peut durer une heure : demandez au visiteur de réessayer plus tard |
| `FORM_MAINTENANCE`, `QUEUE_FAILED`, `INTERNAL_ERROR` | Oui, après une courte attente |
| `502`, `503` ou `504` sans JSON | Oui. Quelque chose devant Formerie a répondu |
| Toute autre réponse sans JSON | Non. Gardez la clé, et voyez ce qui s’est passé |
| `DUPLICATE_SUBMISSION` | Non. Traitez-le comme un succès |
| `VALIDATION_FAILED` et tout autre code | Non. 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](/fr/guides/spam-protection/#ce-que-couvre-la-période-denvois-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`.

```ruby
require "json"
require "net/http"

# posted is what your form sent. origin is the Origin header of the visitor's request.
def submit_verified(posted, origin)
  runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
  # Your form. This is the only line that names it.
  form = ENV.fetch("FORMERIE_FORM", "acme/contact")
  uri = URI("#{runtime_url}/#{form}/submit")

  fields = posted.dup
  token = fields.delete("cf-turnstile-response")
  headers = { "Content-Type" => "application/json" }
  # Without the visitor's Origin, the provider's hostname can't match, and the check fails.
  headers["Origin"] = origin unless origin.to_s.empty?

  response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
    http.post(uri.path, JSON.generate(fields: fields, verificationToken: token), headers)
  end
  JSON.parse(response.body)
end
```

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](/fr/guides/framework-entry-points/#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.

```ruby
require "json"
require "net/http"
require "securerandom"
require "time"

def submit_with_metadata(fields, started_at, visitor_id)
  runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
  # Your form. This is the only line that names it.
  form = ENV.fetch("FORMERIE_FORM", "acme/contact")
  uri = URI("#{runtime_url}/#{form}/submit")
  payload = {
    fields: fields,
    metadata: {
      idempotencyKey: SecureRandom.uuid,
      # When the visitor opened the form, for the minimum submit time check.
      startedAt: started_at.utc.iso8601,
      pageUrl: "https://www.example.com/contact",
      # Your own visitor ID, for a limit rule with the deviceToken scope.
      deviceToken: visitor_id
    }
  }
  response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
    http.post(uri.path, JSON.generate(payload), "Content-Type" => "application/json")
  end
  JSON.parse(response.body)
end
```

| Champ | À quoi il sert |
| --- | --- |
| `idempotencyKey` | La vérification des répétitions, comme ci-dessus |
| `startedAt` | Le 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 |
| `pageUrl` | La page d’où le formulaire a été envoyé. Stockée seulement s’il s’agit d’une adresse http ou https |
| `deviceToken` | Votre 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](/fr/guides/spam-protection/).

## 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.**

| Limite | Par défaut | À partir de votre serveur |
| --- | --- | --- |
| Par visiteur | 30 soumissions toutes les 10 minutes | Partagé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 formulaire | 1 000 soumissions à l’heure | La même. Avec le forfait gratuit, c’est aussi le maximum qu’un formulaire peut accepter |
| Court terme | 120 requêtes à la minute pour chaque formulaire à partir d’une même adresse | Ne 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](https://formerie.com/contact/) 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](/fr/guides/framework-entry-points/#les-limites-avec-un-serveur) pour le raisonnement, et [Forfaits et limites](/fr/guides/plans-and-limits/) pour les compteurs mensuels.

## Rails

Ça fonctionne par l’API : le contrôleur lit le formulaire du visiteur et appelle Formerie avec `net/http`. Le code a été exécuté avec un backend Formerie local et Rails 8.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. Dirigez-y `post "/contact", to: "contact#create"`, et gardez la protection contre la falsification de Rails, avec `form_with` dans votre vue.

```ruby
require "json"
require "net/http"

class ContactController < ActionController::Base
  def create
    runtime_url = ENV.fetch("FORMERIE_RUNTIME_URL", "https://forms.formerie.com")
    # Your form. This is the only line that names it.
    form = ENV.fetch("FORMERIE_FORM", "acme/contact")
    uri = URI("#{runtime_url}/#{form}/submit")
    # Name the fields you send, so a visitor can't add others.
    fields = params.permit(:name, :email, :message).to_h
    answer = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10) do |http|
      http.max_retries = 0
      http.post(uri.path, JSON.generate(fields: fields), "Content-Type" => "application/json")
    end
    result = JSON.parse(answer.body)

    if result["ok"]
      render json: { id: result["submissionUid"] }, status: :accepted
    else
      errors = (result.dig("error", "fields") || {}).transform_values { |issues| issues.map { |issue| issue["message"] } }
      render json: { code: result.dig("error", "code"), errors: errors }, status: answer.code.to_i
    end
  rescue SystemCallError, SocketError, IOError, Timeout::Error, OpenSSL::SSL::SSLError, JSON::ParserError
    # No connection, a timeout, or an answer that isn't JSON. Keep the visitor's answers on screen.
    render json: { code: "TRY_AGAIN" }, status: :service_unavailable
  end
end
```

## Bon à savoir

- `read_timeout` est de 60 secondes par défaut, ce qui est long pour une page que quelqu’un attend. Gardez `open_timeout` et `read_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](/fr/guides/error-codes/) les énumère tous.

| Avec | Note |
| --- | --- |
| L’`Origin` dans Rails | `request.headers["Origin"]`, pour la vérification humaine. |
| Sinatra | `params` contient les réponses, et `request.env["HTTP_ORIGIN"]` l’`Origin` du visiteur. |

Les routes, les champs et toutes les erreurs se trouvent dans la [référence de l’API](/fr/guides/api-reference/).