OAuth 2.0
L'accès à l'API nécessitera une authentification OAuth 2.0 qui, à son tour, nécessitera un utilisateur technique pour un distributeur particulier dans le système d'authentification Schneider.
Pour demander des informations d'identification, veuillez envoyer un e-mail à : distributorapiportal.global@se.com
Comment fonctionne OAuth :
- L'utilisateur de l'API doit disposer d'un ID client statique et d'une clé secrète, ainsi que du point de terminaison de génération de jeton du fournisseur d'API.
- En utilisant les détails ci-dessus, l'API Token doit être appelée avec la méthode POST.
- Cette API renverra le jeton Bearer, qui peut être utilisé pendant 1 heure pour appeler l'API, cela peut être traité comme un identifiant dynamique qui a une expiration d'une heure.
Environnement | Point de terminaison de génération de jeton |
Explorer | https://api.explore.se.com/token |
Dev | https://api.dev.se.com/token |
QA | https://api.qa.se.com/token |
Pre-prod | https://api.preprod.se.com/token |
Production | https://api.se.com/token |
Comment générer un jeton à l'aide de Postman :
- Créer une nouvelle demande d'API avec le point de terminaison d'API réel
- Aller à la section Autorisation
- Sélectionnez Type comme OAuth 2.0
- Sur le côté droit, accédez à Configurer un nouveau jeton
- Le nom du jeton peut être défini par l'utilisateur (par exemple, le nom du distributeur)
- Grant Type = Client Credentials (Sélectionner dans le menu déroulant)
- L'URL du jeton d'accès sera conforme au tableau ci-dessus
- L'ID client et le secret client seront donnés par l'équipe Schneider
- Portée tout
- L'authentification du client peut être Envoyer les informations d'identification du client dans le corps
- Cliquez sur Obtenir un nouveau jeton d'accès
Exemple de génération de jeton à l'aide de la nouvelle requête Postman :
- Sélectionnez POST et entrez l'URL du jeton.
- Dans l'onglet Corps, cliquez sur le bouton radio x-www-form-urlencoded.
- Entrez manuellement la clé et la valeur, "grant_type" et "client_credentials".
- Dans l'onglet Autorisation, sélectionnez Type "Basic Auth".
- Définissez le nom d'utilisateur sur la clé client (qui vous est fournie hors ligne).
- Définissez le mot de passe sur le secret client (qui vous est fourni hors ligne).
- Envoyez la demande et récupérez la valeur de access_token à partir du message de réponse.
Création de demande de génération de jeton à l'aide de CURL dans Postman :
- Dans Postman, sélectionnez l'option Importer (qui se trouve en haut à gauche).
- Dans la boîte de dialogue Importer, sélectionnez Texte brut et collez l'exemple de curl fourni ci-dessous.
- Cliquez sur Continuer puis sur Importer.
- Dans l'onglet En-têtes, remplacez la valeur d'autorisation par la chaîne encodée en base 64 de client_key et client_secret.
Exemple de curl pour la génération de jetons :
curl --location --request POST 'https://api.se.com/token' \
--header 'Authorization: Basic askjdfsaldalskjfdlsajflasdkjfb2h4NVJxMFlSZ2hUbA==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'
Clé API
Pour quelques API, l'accès à l'aide de la clé API est également possible lorsque vous fournissez l'apikey de longue durée en tant que paramètre de requête.
Une fois que vous avez une clé API, vous pouvez exécuter des opérations GET directement dans un navigateur Web.
Format d'URL : https://{hostname}/{BaseURL}/{ResourcePath}?{queryParams}&apikey={your_api-key}