Ajout de clés d'API

Lorsqu'une clé API est attribuée au client externe, celui-ci peut accéder aux données du système Manage et interagir avec elles. L'interaction se fait en utilisant la clé API comme paramètre de requête apikey ou comme en-tête de requête apikey dans les appels à l'API REST. Les appels d'API REST qui utilisent une clé d'API ne créent pas de connexion serveur persistante et la clé d'API doit apparaître dans toutes les demandes d'API REST émises par le client externe.

Avant de commencer

Si vous insérez un certificat lors de l'ajout d'une clé API, veillez à acquérir le certificat au préalable auprès d'une autorité de certification.

Procédure

  1. Dans l'application Clés d'API , cliquez sur Ajouter une clé d'API.
  2. Dans la boîte de dialogue Ajouter une clé d'API , sélectionnez l'utilisateur pour lequel vous créez la clé d'API dans la zone Utilisateur .
  3. Définissez Minutes ou date d'expiration sur on si vous souhaitez spécifier une date d'expiration pour la clé API. Réglez-le sur off si vous voulez spécifier le délai d'expiration en minutes.
  4. Attribuez la valeur true à Certificate si vous souhaitez insérer un certificat pour la clé API ajoutée.
    Le champ Insérer un certificat s'affiche.
  5. Dans le champ Insérer un certificat, collez un certificat valide et unique.
    Le certificat doit être au format commençant par -----BEGIN CERTIFCATE----- et se terminant par -----END CERTFICATE-----. Il doit être conforme à la norme PEM X.509.
    L'exemple suivant est un exemple de certificat :
    -----BEGIN CERTIFICATE-----
MIIEAzCCAuugAwIBAgIQQoHZvObaTzAOe7m+/xDF8DANBgkqhkiG9w0BAQsFADCB
hjELMAkGA1UEBhMCR0IxDzANBgNVBAcTBkxvbmRvbjEPMA0GA1UECRMGTG9uZG9u
MS4wLAYDVQQLEyVJQk0gTWF4aW1vIEFwcGxpY2F0aW9uIFN1aXRlIChQdWJsaWMp
MSU.............................................................
EAxMxbWFuYWdlLmZyYW1l...........................................
MDQyNC5hcHBzLm1hbmFnZS1vY3AyLmNwLmZ5cmUuaWJtLmNvbTCCASIwDQYJKoZI
hvcNAQEBBQADggEPADCCAQoCggEBAPs7owfsm9eZV5z3XQSFCLY3DgnIubJwksrj
BFs+t57O/Ly9w5vZki4VnKkpZ7ZWcICKdGHRO8bFK8UdufDDhgd21YczlQbOlfHh
YemAL2wZUNo8kDp1XyBJn8z53F/cI+Ag1oxYBHhhFzgl4tInQ0IQlhU/nCSPQQ2k
72DIiFz/K593BqMTOv35nVNZJWd2YvkLqJrNYtTnRpf1/o6gLs/qOzKwmDvwiQhv
uhDwIfSn3kVk/EvcSXndlBuRWIuhjMc3uhB3dPnOLwR8VSoy5JhPyGbPIcpupODH
TmYqJjrNqoPgSVBLlTcfxMZOVTGZZzC9PV8Qv55ADNb045ehE6MCAwEAAaOBtTCB
sjAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBQJ5HnO
................................ajBogjFtYW5hZ2UuZnJhbWUwNDI0LmFw
cHMubWFuYWdlLW9jcDIuY3AuZnlyZS5pYm0uY29tgjMqLm1hbmFnZS5mcmFtZTA0
MjQuYXBwcy5tYW5hZ2Utb2NwMi5jcC5meXJlLmlibS5jb20wDQYJKoZIhvcNAQEL
BQADggEBACFOl5PI2VTDkI8uUmB1ZnUZkTTdsXjpAc9QZTCpwgS42drq9PFdJRir
5cUQBsRsfnXTTywKor01NkMf5rrgZwomqwDXl6fGJyODGEdbICN1x8VNGuAEkmxK
fmly/MMKQRyl7xbFOvCITxNNNwL+VpLovtTOi46aK82qg5dBHRy7sBmwT3mKmnvz
................................................................
/hwjphuBId3imKjz6dZculYspxg39NmHhDTsMUqugNSoROJkZ1vGkdRK9kQSchaE
7ckHUx1cFCG/86................=
-----END CERTIFICATE-----
    Remarque :
    • Si vous n'insérez pas de certificat, une clé API normale est créée.
    • Si vous insérez un certificat non valide, le système répond par une erreur.
    • Si vous insérez un certificat en double, le système ne l'accepte pas.
    • Les certificats ont leur propre date d'expiration. Si vous avez défini une date d'expiration pour la clé API, c'est la date la plus ancienne qui s'applique.
  6. Cliquez sur Créer pour ajouter la clé API.
    Vous pouvez consulter la date d'expiration et savoir s'il s'agit d'une clé API basée sur un certificat après avoir créé la clé API, dans la carte résultante de l'application API.

Etapes suivantes

Si vous insérez un certificat lorsque vous ajoutez une clé API, vous devez l'ajouter aux certificats approuvés dans l'interface utilisateur Maximo® Application Suite de l'interface utilisateur.
  1. Dans le menu d' administration de Suite, allez dans Espaces de travail et sélectionnez la tuile Gérer.
  2. Cliquez sur Actions > Mettre à jour la configuration.
  3. Dans la fenêtre de configuration Update Manage, cliquez sur l'icône Modifier dans la ligne Certificats importés.
  4. Cliquez sur Ajouter pour spécifier un nom d'alias et coller le contenu du certificat.
  5. Cliquez sur Confirmer.
  6. Cliquez sur Appliquer les modifications pour enregistrer les changements dans la configuration.
Pour que WebSphere® Application Server Liberty accepte le certificat, vous devez configurer un itinéraire.
  1. Connectez-vous à la console web Red Hat® OpenShift® en utilisant vos identifiants d'administrateur.
  2. Dans le menu de navigation latéral, cliquez sur Administration > CustomResourceDefinitions.
  3. Sur la page CustomResourceDefinitions recherchez ManageWorkspace.
  4. Cliquez sur l' espace de gestion, puis sur l'onglet Instances.
  5. Sélectionnez une instance et cliquez sur l'onglet YAML.
  6. Dans la section spec.settings.deployment , ajouter certPassthroughRoute: true.
  7. Cliquez sur Sauvegarder. Un rapprochement est automatiquement déclenché et, une fois terminé, vous pouvez visualiser le nouvel itinéraire en allant dans Réseau > Itinéraires.
    Remarque : si vous attribuez la valeur false à la propriété certPassthroughRoute , l'itinéraire n'est pas supprimé. Vous devez supprimer manuellement l'itinéraire.