Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

API S’authentifier avec le nom d’utilisateur et la clé API

  • Mis à jour le : 1/06/2021
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA
    • Docs API

API S’authentifier avec le nom d’utilisateur et la clé API

Générer un jeton Web JSON avec votre nom d’utilisateur de Salle de contrôle et une clé API. Ce point de terminaison permet aux utilisateurs de générer le jeton sans avoir besoin du mot de passe de l’utilisateur, par exemple pour les organisations qui utilisent l’authentification unique (SSO). Par défaut, un jeton est valide pendant 20 minutes.

Prérequis

Remarque : Vous pouvez afficher l’Control Room APIs dans la Édition Community, mais la fonctionnalité de l’API est limitée. Vous avez besoin d'une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalité API.

Pour générer le jeton, vous avez besoin des éléments suivants :

  • Un rôle personnalisé avec l’autorisation Générer une clé API
  • Un Nom d’utilisateur valide et une clé API pour la Salle de contrôle. La clé API se présente sous la forme d’une chaîne de 40 caractères générée dans la Salle de contrôle.

    Création et attribution du rôle de génération de clés API

Procédure

  1. Utilisez la méthode POST et l’URL du point de terminaison : <your_control_room_url>/v1/authentication.
    Corps de la requête :
    {
    "username": "jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
    Corps de requête avec domaine : Selon la manière dont votre Salle de contrôle est configurée, un domaine peut être nécessaire en plus du nom d’utilisateur.
    {
    "username": "your-domain\\jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
  2. Envoyez la requête.
    Corps de réponse : Une réponse réussie renvoie le jeton sous la forme d’une chaîne de 703 caractères.
    {
      "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
      "user": {
        "id": 9,
        "email": "a@a.com",
        "username": "jdoe",
        "domain": null,
        "firstName": "",
        "lastName": "",
        "version": 9,
        "principalId": 9,
        "deleted": false,
        "roles": [
          {
            "name": "API_Key_Generation",
            "id": 23,
            "version": 0
          },
          {
            "name": "AAE_Basic",
            "id": 2,
            "version": 0
          },
          {
            "name": "Docrole1",
            "id": 18,
            "version": 0
          }
        ],
        "sysAssignedRoles": [],
        "groupNames": [],
        "permissions": [
    
    	. . .
    
        ],
        "licenseFeatures": [
          "RUNTIME"
        ],
        "emailVerified": true,
        "passwordSet": true,
        "questionsSet": true,
        "enableAutoLogin": false,
        "disabled": false,
        "clientRegistered": false,
        "description": "",
        "createdBy": 1,
        "createdOn": "2019-10-10T13:39:56-05:00",
        "updatedBy": 1,
        "updatedOn": "2019-10-13T02:09:38-05:00",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null
      }
    }

Étapes suivantes

Insérez le jeton dans l’en-tête de la requête des demandes d’API suivantes.
Envoyer le commentaire