Appeler un flux avec un point de terminaison API à l'aide d'un jeton client

Le flux du point de terminaison de l'API est enregistré en tant que webhook et est sécurisé par un jeton client unique. Il n'est accessible que si le service demandeur transmet le jeton client approprié via l'URL d'invocation. L'URL d'invocation est construite à l'aide d'un alias de flux.

Une fois que vous avez invoqué un flux, celui-ci envoie la sortie du flux sous la forme d'un objet de réponse.

Utilisez la procédure suivante pour invoquer un flux via un webhook enregistré.

Créer votre flux

Pour les flux de point de terminaison API existants, vous pouvez sauter ces deux étapes de création de flux. À la place, cliquez sur l'icône Paramètres du point de terminaison API endpoint settings icon. qui s'affiche au bas de la carte d'événement Point de terminaison API dans votre flux.

  1. Créez un flux dans votre Workflows Console et cliquez sur Ajouter un événement.

  2. Dans la boîte de dialogue Choisir une app pour démarrer votre flux, sélectionnez Point de terminaison API.

Configurer vos paramètres de point de terminaison API

  1. Dans la boîte de dialogue Paramètres du point de terminaison API, sélectionnez Sécuriser avec un jeton client comme niveau de sécurité.

  2. Lorsque vous sélectionnez cette option, elle génère un jeton client pour identifier le webhook enregistré. Ce jeton client unique est automatiquement ajouté en tant que valeur d'alias dans les champs URL d'invocation et URL de reprise.

  3. Cliquez sur Copier pour enregistrer l'URL dans le champ URL d'invocation.

  4. Cliquez sur Fermer pour confirmer les paramètres modifiés du point de terminaison.

Tester votre flux de point de terminaison API

Pour invoquer le flux, effectuez une requête GET ou POST vers l'URL d'invocation. Utilisez la méthode POST si vous devez envoyer des données dans le corps de la requête.

Si nécessaire, authentifiez votre requête en utilisant l'une des méthodes suivantes.

  • Transmet le jeton client fourni à l'aide du paramètre de requête clientToken. Il s'agit du comportement par défaut.

  • Transmet le jeton client fourni en tant que valeur dans l'en-tête x-api-client-token. Il s'agit de l'option la plus sécurisée. Cependant, ne l'utilisez pas avec le paramètre de requête clientToken.