---
title: "Test inline de l'API BAN (Base Adresse Nationale) depuis Settings."
method: GET
path: "/api/v1/integrations/ban/test-search"
tags: ["Intégrations"]
---

# Test inline de l'API BAN (Base Adresse Nationale) depuis Settings.

`GET /api/v1/integrations/ban/test-search`

## Request

- Base URL: `https://erp.eyeot.fr/api/v1`
- URL: `https://erp.eyeot.fr/api/v1/api/v1/integrations/ban/test-search`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Test inline de l'API BAN (Base Adresse Nationale) depuis Settings.

    GET `?q=<text>` — wrapper léger sur le provider BAN existant.
    Permet a l'admin de valider que l'API BAN repond depuis sa modale
    de configuration (auth_type=none) sans avoir a aller dans /clients
    ou /chantier pour tester.

    Cache 60s côté Flask cache (key = q normalisé).

    Retour 200 :
        {
          "suggestions": [{label, postcode, city, score}, ...],
          "count": N
        }
    Retour 422 si q vide/<3 chars.
    Retour 503 si l'API BAN est down/timeout.

**Permissions requises** : `admin:settings`

## Response `200`

Succès — payload `{data, meta}` (cf. API-GUIDE §3.1)

## Other responses

- `401`: JWT manquant, expiré ou révoqué.
- `402`: L'organisation n'a pas d'abonnement actif (paywall). Rediriger vers /activate.
- `403`: Permissions `module:action` insuffisantes pour cette route.
- `404`: Ressource introuvable (ou cross-tenant — équivalent à hidden).
- `429`: Trop de requêtes. Honorer le header `Retry-After` (secondes).

---

[API](https://skmtc.dev/eyeot/apis/eyeot-erp-api.md) · [All operations](https://skmtc.dev/eyeot/apis/eyeot-erp-api/llms.txt) · [OpenAPI document](https://skmtc.dev/eyeot/apis/eyeot-erp-api/revisions/42ab95222a89?raw)
