Démarrage rapide
Ce guide va vous permettre de de mettre en place votre environnement de communication avec l'API Shunter. Nous travaillerons avec Curl afin d'établir une communication avec les services Shunter.
L'API de Shunter est basée sur unr achitecture REST supportant les methodes POST, GET, PATCH et DELETE.
Vous pouvez intéragir avec l'API de Shunter via des contenus JSON avec l'en tête application/json ou via des contenus url-encodés en utilisant l'en tête application/x-www-form-urlencoded.
Avant de faire votre première requête à l'API de Shunter, vous devez vous munir de votre clé API générée depuis votre tableau de bord d'organisation. Vous la trouverez sous Paramètres » API.
Votre premier appel API (GET)
Une fois votre clé API récupérée, vous êtes prêt à faire votre premier appel à l'API de Shunter. Vous pourrez voir ci-dessous comment faire un appel GET à la ressource Events afin de retrouver la liste des évènements de votre organisation pour lesquels votre clé API dispose d'un droit de regard. Dans cet exemple, le nombre de résultats sont limités à 100, la limite par défaut pour tous les appels GET.
curl -G https://api.shunter.fr/v1/organizers/:_id/events?limit=100 \
-H "Authorization: X-API-KEY {YOUR_KEY}" \