Allez viens est construit « API d’abord » : le site, les applis et les partenaires lisent les mêmes données, par la même API publique et versionnée.
Ce qu’elle donne
- la recherche (`/v1/search`) : les sorties par lieu, dates, catégories, prix, groupe, avec les mêmes filtres et le même classement que le site ;
- une fiche (`/v1/events/{slug}`) : dates, lieu, tarifs, organisateur, sources ;
- les lieux (`/v1/places`) : les communes et les lieux, pour un champ « Où » ;
- les libellés (`/v1/taxonomy`) : catégories et filtres, en français ;
- l’aide (`/v1/help`) : les pages de ce centre d’aide.
Elle se lit seulement : on n’y écrit pas d’événement. Sa description complète, au format OpenAPI, est à l’adresse `/v1/openapi.json` de l’API, ouverte sans clé.
Les clés
Chaque requête porte une clé dans l’en-tête `X-Api-Key`. Pour en obtenir une, écris à l’équipe (lien plus bas) en disant qui tu es et ce que tu veux en faire.
- la clé t’est donnée une seule fois : Allez viens n’en garde qu’une empreinte, jamais la clé elle-même ;
- chaque clé a une limite de requêtes par minute, indiquée dans les en-têtes `X-RateLimit-Limit`, `X-RateLimit-Remaining` et `X-RateLimit-Reset` ;
- au-delà, l’API répond `429` avec `Retry-After` : le nombre de secondes à attendre.
Juste besoin des dates d’une commune dans un agenda ? Pas besoin de clé : les agendas iCal.