Présentation de l'API

CrowdHandler propose une API RESTful au format JSON. Il existe deux types de méthodes :

publique#

L'API publique sert à valider les utilisateurs sur votre site web. Vous pouvez envoyer un jeton et une URL pour obtenir des informations sur l'utilisateur présentant ce jeton. La réponse vous indiquera si cet utilisateur est déjà autorisé à accéder à l'URL ou s'il doit être redirigé vers une salle d'attente. D'autres méthodes permettent d'enregistrer les performances de la page afin que CrowdHandler puisse surveiller les performances de votre domaine.

L'accès aux méthodes publiques s'effectue à l'aide d'une clé publique, qui est propre à votre compte.

Toutes les formules, y compris la formule d'entrée de gamme, donnent accès à l'API publique.

L'API publique n'est soumise à aucune limitation de débit, hormis celle liée au débit entrant de votre domaine.

privée#

L'API privée sert à gérer votre compte, vos domaines et vos salles d'attente. Elle donne accès à toutes les fonctionnalités disponibles via le panneau d'administration, ce qui vous permet de les gérer par programmation.

L'accès aux méthodes privées s'effectue à l'aide d'une clé privée propre à votre compte.

Seuls certains abonnements payants donnent accès aux méthodes privées.

L'API privée est soumise à une limitation de débit en fonction de votre forfait. Les limites de débit commencent à 100 appels par minute.

Accéder à vos clés API et à la documentation :

Vous pouvez accéder à vos clés API et à la documentation depuis le panneau d'administration. Sélectionnez « Compte » > « API ».

Vous êtes désormais prêt à vous lancer dans la mise en œuvre d'une intégration d'API.