Obtenir une clé

L'API est réservée aux comptes au plan Pro. L'essai de 7 jours et le plan gratuit n'y donnent pas accès. Il n'existe pas de page libre-service : une clé est émise par l'équipe PublikConnect, sur demande, pour un compte précis. Elle commence par pk_live_ et n'est affichée qu'une seule fois à l'émission ; PublikConnect n'en conserve que l'empreinte, donc une clé perdue ne se récupère pas et se remplace.

Une clé vaut pour un seul compte et pour les périmètres qui lui ont été donnés (voir plus bas). Les opportunités de /opportunites sont celles de ce compte, et rien dans la requête ne permet de lire celles d'un autre. Si le compte quitte le plan Pro, ou si la clé est révoquée, la clé cesse de fonctionner au plus tard une minute plus tard.

Périmètres et usage de la clé

Une clé ne lit pas tout : elle porte des périmètres, fixés par l'équipe PublikConnect à l'émission. Une route qui exige un périmètre que la clé n'a pas répond 403 (forbidden), après l'authentification et le contrôle de débit.

Une clé émise sans périmètre reçoit donc 403 partout, sauf sur /departements, /sources et /moi. Le périmètre exigé par chaque route est aussi écrit dans sa description du document OpenAPI. Un changement de périmètre, d'usage ou une révocation est vu au plus tard une minute plus tard.

L'usage de la clé est lui aussi posé par l'équipe :

• interne : l'organisation du client et son produit fermé. Toutes les sources servies ;
• rediffusion : seules les sources dont la licence autorise la rediffusion sont servies, sur toutes les routes d'avis, sur les compteurs de /departements et dans la liste de /sources. Dans ce cas, source=<code d'une source non rediffusable> donne 400, et l'avis d'une source non rediffusable répond 404 sur /avis/{id}, comme un identifiant inconnu.