Aller au contenu
Documentation Arnakoff

Lister les signaux

GET
/v1/signals
curl --request GET \
  --url https://api.arnakoff.com/v1/signals

Le catalogue des signaux qu’une vérification peut donner, celui de docs/signals.md. Un code donné par plusieurs sources a une entrée par source, comme un signal de GET /v1/check.

Responses

Section intitulée « Responses »

200

Section intitulée « 200 »

Le catalogue des signaux.

Media typeapplication/json

Le catalogue des signaux.

object
signals
required
Array<object>

Un signal qu’une vérification peut donner.

object
code
required

Identifiant stable du signal.

string
/^[a-z][a-z0-9_]*$/
level
required

Gravité d’un signal, de la plus faible à la plus forte : info (fait neutre), attention (indice à vérifier avant d’agir), alerte (fait publié par une autorité, comme une inscription sur une liste noire).

string
Allowed values: info attention alerte
inputs
required

Les types d’entrée qui peuvent donner ce signal.

Array<string>
>= 1 items unique items
Allowed values: domain email phone iban siren siret
source
required

Nom d’une source, tel qu’il est montré aux utilisateurs.

string
>= 1 characters
condition
required

Quand le signal est donné, en français.

string

Examples

Examplesignals

Un signal du catalogue

{
  "signals": [
    {
      "code": "amf_blacklist",
      "level": "alerte",
      "inputs": [
        "domain",
        "email"
      ],
      "source": "AMF",
      "condition": "Site inscrit ou adresse e-mail inscrite à l'identique"
    }
  ]
}

Headers

Section intitulée « Headers »
RateLimit
required
string

Quota restant de la politique en cours, selon draft-ietf-httpapi-ratelimit-headers-11 : r, requêtes encore permises maintenant ; t, secondes avant qu’une requête de plus soit rendue (pendant ce délai, pas plus de r requêtes), 0 quand le quota est entier.

Example 
"key";r=59;t=1
RateLimit-Policy
required
string

Politique de quota, selon draft-ietf-httpapi-ratelimit-headers-11 : q, requêtes permises par fenêtre ; w, fenêtre en secondes. Le quota entier peut être dépensé d’un coup, puis il revient au même rythme sur la fenêtre. Politique key sur les routes de vérification, par clé API (un lot compte pour une requête) ; politique ip sur les routes sans clé, par adresse du client (préfixe /64 en IPv6) ; politique auth sur les routes de vérification, par adresse du client, qui compte les clés refusées (mal formées, inconnues ou révoquées) : une fois ce quota dépensé, les clés envoyées depuis cette adresse ne sont plus vérifiées et la réponse est 429, même pour une clé valide. La politique auth n’apparaît que sur ses réponses 429. Sur POST /v1/demo/check, politique demo par adresse du client et politique demo_global pour tous les clients ensemble, qui n’apparaît que sur ses réponses 429. Sur POST /v1/keys/request et POST /v1/keys/redeem, politique key_request par adresse du client. Valeurs de l’exemple données à titre d’illustration : les quotas dépendent de l’offre.

Example 
"key";q=60;w=60

429

Section intitulée « 429 »

Quota dépassé : celui de la clé (key), de l’adresse (ip), des clés refusées depuis l’adresse (auth), de l’accès de démonstration (demo, demo_global) ou des demandes de clé (key_request), nommé dans RateLimit-Policy.

Media typeapplication/problem+json

Erreur au format RFC 9457 (application/problem+json).

object
type
required

Adresse de la page du site qui documente ce type d’erreur : la documentation des erreurs suivie du code.

string format: uri
title
required

Résumé du type d’erreur, en français, le même pour toutes ses occurrences.

string
status
required

Code de statut HTTP de la réponse.

integer
>= 400 <= 599
detail
required

Explication de cette occurrence, en français. Ne cite jamais une donnée personnelle.

string
instance

Identifiant de cette occurrence : l’URI tag:arnakoff.com,2026:request: suivie de l’identifiant de la requête, celui de l’en-tête X-Request-ID de la réponse. À citer quand on signale un problème. Absent d’une erreur d’un élément de POST /v1/check/batch.

string format: uri-reference
code
required

Identifiant stable du type d’erreur (liste ouverte). Chaque code a un exemple Problem… dans ce contrat.

string
/^[a-z][a-z0-9_]*$/

Examples

Examplequota

Quota dépassé

{
  "type": "https://arnakoff.com/docs/erreurs/too_many_requests",
  "title": "Trop de requêtes",
  "status": 429,
  "detail": "Le quota de requêtes est atteint. Réessaie après le délai de l'en-tête Retry-After.",
  "instance": "tag:arnakoff.com,2026:request:7NQJ4ZWKX3C5RB2D6HVMTPLE9A",
  "code": "too_many_requests"
}

Headers

Section intitulée « Headers »
RateLimit
required
string

Quota restant de la politique en cours, selon draft-ietf-httpapi-ratelimit-headers-11 : r, requêtes encore permises maintenant ; t, secondes avant qu’une requête de plus soit rendue (pendant ce délai, pas plus de r requêtes), 0 quand le quota est entier.

Example 
"key";r=59;t=1
RateLimit-Policy
required
string

Politique de quota, selon draft-ietf-httpapi-ratelimit-headers-11 : q, requêtes permises par fenêtre ; w, fenêtre en secondes. Le quota entier peut être dépensé d’un coup, puis il revient au même rythme sur la fenêtre. Politique key sur les routes de vérification, par clé API (un lot compte pour une requête) ; politique ip sur les routes sans clé, par adresse du client (préfixe /64 en IPv6) ; politique auth sur les routes de vérification, par adresse du client, qui compte les clés refusées (mal formées, inconnues ou révoquées) : une fois ce quota dépensé, les clés envoyées depuis cette adresse ne sont plus vérifiées et la réponse est 429, même pour une clé valide. La politique auth n’apparaît que sur ses réponses 429. Sur POST /v1/demo/check, politique demo par adresse du client et politique demo_global pour tous les clients ensemble, qui n’apparaît que sur ses réponses 429. Sur POST /v1/keys/request et POST /v1/keys/redeem, politique key_request par adresse du client. Valeurs de l’exemple données à titre d’illustration : les quotas dépendent de l’offre.

Example 
"key";q=60;w=60
Retry-After
required
integer

Secondes à attendre avant de réessayer (RFC 9110, section 10.2.3).

Example 
30

500

Section intitulée « 500 »

Erreur interne du serveur.

Media typeapplication/problem+json

Erreur au format RFC 9457 (application/problem+json).

object
type
required

Adresse de la page du site qui documente ce type d’erreur : la documentation des erreurs suivie du code.

string format: uri
title
required

Résumé du type d’erreur, en français, le même pour toutes ses occurrences.

string
status
required

Code de statut HTTP de la réponse.

integer
>= 400 <= 599
detail
required

Explication de cette occurrence, en français. Ne cite jamais une donnée personnelle.

string
instance

Identifiant de cette occurrence : l’URI tag:arnakoff.com,2026:request: suivie de l’identifiant de la requête, celui de l’en-tête X-Request-ID de la réponse. À citer quand on signale un problème. Absent d’une erreur d’un élément de POST /v1/check/batch.

string format: uri-reference
code
required

Identifiant stable du type d’erreur (liste ouverte). Chaque code a un exemple Problem… dans ce contrat.

string
/^[a-z][a-z0-9_]*$/

Examples

Exampleinternal

Erreur interne

{
  "type": "https://arnakoff.com/docs/erreurs/internal_error",
  "title": "Erreur interne",
  "status": 500,
  "detail": "Le serveur a rencontré une erreur. Réessaie plus tard.",
  "instance": "tag:arnakoff.com,2026:request:7NQJ4ZWKX3C5RB2D6HVMTPLE9A",
  "code": "internal_error"
}