Handle OAuth Authentication using API Gateway Pre-request Configuration – OptiSigns

Dans cet article, nous expliquerons comment configurer une pré-requête pour récupérer un jeton d'accès OAuth 2.0 afin de se connecter à une API à l'aide d'une passerelle API.

La passerelle API OptiSigns permet l'authentification OAuth via la pré-requête. Cela donne aux utilisateurs la possibilité de consommer des API qui nécessitent une authentification OAuth ou similaire.

Pour commencer, vous devrez configurer une requête API. Survolez Nom du compte → Plus → Cliquez sur Sources de données :

how to navigate to datasource

De là, cliquez sur Ajouter une requête.

datasources add request button

Créez une requête GET et saisissez votre point de terminaison API, puis cliquez sur Pré-requête :

optisigns api request form pre-request

Dans le champ Pré-requête, saisissez le code suivant :

const body = {
  "grant_type": "client_credentials",
  "client_id": "<CLIENT_ID>",
  "client_secret": "<CLIENT_SECRET>"

};
const params = Object.keys(body || {}).map((key) => {
        return key + '=' + body[key];
      }).join('&');

const {data, headers} = await os.postRequest("<OAUTH_AUTHENTICATION_URL>", params,{headers: {'content-type': 'application/x-www-form-urlencoded'}});
const token = 'Bearer' + data.access_token;
os.context.set("request.headers.authorization", token);

Remarques :

"grant_type" : Utilisez "client_credentials", car "client_credentials" est le type d'octroi dans OAuth pour l'intégration côté serveur sans interaction utilisateur.
<CLIENT_ID> et <CLIENT_SECRET> font référence au code de l'utilisateur pour l'API à laquelle on accède, ceux-ci devront être fournis par l'utilisateur.
<OAUTH_AUTHENTICATION_URL> fait référence à l'URL à partir de laquelle le jeton d'accès est récupéré. Cette URL devra être fournie par l'utilisateur.

Configurez maintenant l'En-tête :

properly configured API header

Avec cela et le reste des champs obligatoires remplis, vous avez correctement configuré votre pré-requête. En cliquant sur Exécuter le test, vous devriez obtenir une réponse 200 OK.

successful api request

Si c'est le cas, cliquez sur Enregistrer pour terminer votre requête API.

C'est tout !

Si vous avez des questions supplémentaires, des préoccupations ou des commentaires sur OptiSigns, n'hésitez pas à contacter notre équipe d'assistance à l'adresse support@optisigns.com.