API publique · OpenAPI · Quotas documentes

Documentation publique de l'API Explorer 1dex.

Les endpoints `/api/v1`, la documentation machine, les limites d'appels et les liens d'habilitation en un seul endroit public.

OpenAPI Reference API

$ curl "https://1dex.fr/api/v1/public-preview?path=/ville/paris-75056"

{
  "version": "public-preview-v1",
  "kind": "city",
  "canonicalPath": "/ville/paris-75056"
}

Racine API. https://1dex.fr/api/v1

Beta. https://beta.1dex.fr/api/v1

Quickstart

Un endpoint public, une reponse JSON stable.

La premiere route documentee expose la previsualisation publique utilisee par les pages ville, voie, place et rue.

JavaScript

const apiRoot = "https://1dex.fr/api/v1";
const response = await fetch(
  `${apiRoot}/public-preview?path=${
    encodeURIComponent("/ville/paris-75056")
  }`,
  { headers: { accept: "application/json" } },
);

const preview = await response.json();

Python

from urllib.parse import quote
from urllib.request import Request, urlopen
import json

api_root = "https://1dex.fr/api/v1"
path = quote("/ville/paris-75056", safe="")
request = Request(
    f"{api_root}/public-preview?path={path}",
    headers={"accept": "application/json"},
)

with urlopen(request, timeout=10) as response:
    preview = json.load(response)

Contrat API

Endpoints `/api/v1` publics documentes.

Le contrat OpenAPI public est versionne dans le depot et publie avec le site.

GET /api/v1/public-preview GET /api/v1/public-preview/{kind}/{slug} GET /api/v1/address-overview GET /api/v1/autocomplete/address GET /api/v1/address-pages/{slug}/state GET /api/v1/map-layer/{layer_key} GET /api/v1/map-viewport GET /api/v1/map-focus/*

Liens officiels

Les champs a fournir pour un catalogue API.

Lien racine de l'API. https://1dex.fr/api/v1

Documentation machine. openapi/1dex-public-api.yaml

Documentation technique. docs/api-reference.md

Outil d'habilitation. https://1dex.fr/contact

Documentation metier. docs/datasets.md

Limites d'appels. docs/rate-limits.md

Quotas

Budget pondere par famille de requetes.

Anonyme: 180 points/min, 450 points/heure, 900 points/jour. Authentifie: 300/min, 1 500/heure, 4 000/jour. Abonne: 600/min, 10 000/heure, 60 000/jour.

Public-safe

Fait pour documenter le public, pas pour exposer l'interne.

La documentation publique ne publie pas de secrets, de schemas internes, de raw data ni de procedures operateur.

Authentification. Les lectures publiques peuvent etre anonymes dans les quotas; les usages partenaires passent par habilitation manuelle.

Erreurs. Les erreurs `access_locked` et `usage_limited` sont documentees pour les clients machine.

SEO. Le site pointe vers 1dex.fr, l'OpenAPI et le depot GitHub.

Pret a tester

Demarrez avec une page publique.

Quickstart GitHub