Créer sa clé d'api

remarque

Attention, en plus d'une clé d'api, il vous faut impérativement une tracking key fourni par votre organisation.

Pour créer une clé d'api, il vous suffit d'aller dans les paramètres de votre marché puis dans "Clés d'api". Enfin, vous pouvez sur la fenêtre gérer vos clés et leurs accès.

Une fois la clé d'api créée vous aurez l'affichage de votre clé et de son secret.

attention

Attention, le secret est visible seulement à la création de la clé, veuillez bien le sauvegarder en lieu sûr

Scopes de la clé d'api

Les scopes de la clé d'api définissent les accès que vous avez sur l'api. Vous pouvez choisir parmi les scopes suivants :

• admin : Accès complet à l'api
• memberships-manager : Gestion des adhésions
  • memberships-viewer : Consultation des adhésions (possible seulement si vous avez le scope memberships-manager)
• scanner-manager : Gestion des scanners
• scanner : Utilisation des scanners
• order-manager : Gestion des commandes
  • order-exporter : Export des commandes (possible seulement si vous avez le scope order-manager)
• sales-manager : Gestion des ventes
• sales-viewer : Consultation des ventes

Tracking key

La tracking key est une clé qui vous permet de vous identifier sur l'api et de contrô ler l'accès. Elle est fournie par votre organisation. Vous devez la demander à votre organisation. Une fois la clé en votre possession, vous devez l'ajouter à votre requête en header. La clé doit être ajoutée dans le header X-API-KEY.

Exemple de requête avec la tracking key :

GET /api/market/cinewooch/sales/cinewooch-festival-de-cinema-films-du-monde
....
X-Api-Key: akey-thisIsTheDemoKeyAccess
...