Utiliser l'API de l'opérateur

Utilisation de l'API de l'opérateur

Comment configurer l'API Opérateur

L'ajout d'opérateurs sur votre site est nécessaire pour alimenter les utilisateurs qui utiliseront les applications développées dans Tulip. Les opérateurs sont traditionnellement créés dans les Paramètres par les Propriétaires de Compte. Vous pouvez également créer ces opérateurs en utilisant un système externe via l'API de Tulip.

Ajouter un Token API d'opérateur

Dans votre site Tulip, naviguez vers votre profil dans le coin supérieur droit.

Sélectionnez les options Paramètres dans ce menu.

Dans Paramètres, sélectionnez l'option Jetons API.

Sur le côté droit de cette page, sélectionnez Créer un jeton API.

Dans la section Création, donnez un nom au jeton API et assurez-vous que l'étendue Utilisateurs:Écrire est sélectionnée, puis cliquez sur Créer.

Remarque : veillez à enregistrer les informations relatives au jeton API pour la clé API, le secret et l'en-tête d'autorisation.

Utilisation de l'API de l'opérateur

La section suivante explique comment créer un opérateur. Dans ce cas, l'exemple utilisera Postman pour effectuer la création.

Tout d'abord, ajoutez votre point de terminaison API à la requête Post.

Ensuite, sous Autorisation, sélectionnez Auth de base et ajoutez la clé API comme nom d'utilisateur et le secret API comme mot de passe.

Sous En-têtes, ajoutez l'en-tête Auth.

Dans Body, formatez la demande pour qu'elle contienne l'objet JSON. Le format générique de cette demande est le suivant.

{"role" : "operator", "name" : "string", "badge_id" : "chaîne" }

Cela ressemblera à quelque chose comme ceci :

Appuyez sur send pour exécuter la demande, et vous recevrez une réponse 201 indiquant que la demande a abouti. Pour vérifier, vous pouvez consulter votre liste d'utilisateurs dans les paramètres et confirmer que l'utilisateur a été créé avec succès.

Si la demande a échoué, vérifiez que la clé et le secret sont corrects. Pour plus d'informations sur les codes de réponse spécifiques, consultez la section Documentation de l'API sur la page Tokens de l'API.

Vous avez trouvé ce que vous cherchiez ?

Vous pouvez également vous rendre sur community.tulip.co pour poser votre question ou voir si d'autres personnes ont rencontré une question similaire !