Présentation de l'API

Présentation de l'API#

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

Public API#

The Public API is used to validate users on your website. You can send a token and URL to receive details on the user presenting the token. The response will tell you whether that user is pre-cleared for access to the URL, or whether they should be redirected to a waiting room. Other methods are used to register the performance of the page to allow CrowdHandler to monitor the performance of your domain.

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

All plans, including the starter plan, provide access to the Public API.

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

Private API#

The Private API is used for managing your account, your domains and your waiting rooms. It provides access to all features that are available via the Admin Panel, so that you can handle them programmatically.

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.

The Private API is rate-limited based on your plan. Rate limits start at 100 calls/minute.

Accessing your API keys and the documentation#

Your API keys and the documentation are both accessed via the Admin Panel. Select Account → API.

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