Configuration de la API ConnectAI Gateway boîte à outils

Vous utiliserez l'URL chaque fois que vous vous connecterez au kit d'outils à partir de l'interface de ligne de commande : par conséquent, sauvegardez-en une copie que vous pourrez facilement retrouver.

Le contenu du fichier dépend de l'option de la boîte à outils et de la plateforme que vous avez choisies, comme suit :

• Le fichier apic-slim ou apic-slim.exe est l'interface de ligne de commande pour IBM API ConnectAI Gateway.
• Le fichier apic ou apic.exe est l'interface de ligne de commande pour IBM API ConnectAI Gateway.
  Astuce : si vous utilisez l'option CLI, en renommant le apic-slim fichier en apicou le apic-slim.exe fichier en apic.exe, vous pourrez exécuter les commandes CLI exactement comme indiqué dans la documentation, copier-coller les exemples de commandes de la documentation et utiliser les scripts de commande tels quels si vous passez ultérieurement à l'option CLI + Designer.
• Le fichier api_designer-platform est l'application d'interface utilisateur d'API Designer pour la plateforme spécifiée.

• Pour les plateformes Mac OSX ou Linux® , procédez comme suit:
  1. Ouvrez une fenêtre de terminal et accédez au dossier dans lequel vous avez extrait le contenu du fichier compressé du kit d'outils.
  2. Entrez la commande suivante pour que le fichier d'interface CLI soit exécutable :

     chmod +x download_name

     Où nom_téléchargement est le nom du fichier du kit d'outils téléchargé, apic ou apic-slim.
  3. Exécutez les commandes CLI suivantes :

     ./apic command_name_and_parameters

     ou

     ./apic-slim command_name_and_parameters

     Pour plus d'informations sur les commandes de l'interface en ligne de commande (CLI), consultez la documentation de référence de la CLI de la boîte à outils.
• Pour la plateforme Windows™, procédez comme suit :
  1. Ouvrez une fenêtre d'invite de commande et accédez au dossier dans lequel vous avez extrait le contenu du fichier compressé du kit d'outils.
  2. Exécutez les commandes CLI suivantes :

     apic command_name_and_parameters

     ou

     apic-slim command_name_and_parameters

     Pour plus d'informations sur les commandes de l'interface en ligne de commande (CLI), consultez la documentation de référence de la CLI de la boîte à outils.

Installez les données d'identification du kit d'outils en ouvrant une fenêtre de terminal (ou une invite de commande Windows) et en exécutant la commande suivante:

apic client-creds:set <toolkit_credentials_file_path>/credentials.json

où < credentials_file_path> est l'emplacement dans lequel vous avez téléchargé le fichier JSON des données d'identification du kit d'outils. Le kit d'outils utilise ces nouvelles données d'identification pour s'authentifier auprès du serveur hébergeant le gestionnaire d'API.

Installez les données d'identification API Designer en définissant la variable d'environnement APIC_DESIGNER_CREDENTIALS sur l'emplacement de téléchargement des données d'identification, à l'aide du mécanisme approprié à votre système d'exploitation.

Windows: créez une variable d'environnement à l'aide de l'une des méthodes suivantes.

• Créez une variable d'environnement permanente pour pouvoir démarrer API Designer à partir de n'importe quel emplacement de votre ordinateur:
  1. Ouvrez la page « Variables d'environnement » : cliquez sur Démarrer > Paramètres > Système, puis, dans la section « Paramètres associés » de la page, cliquez sur Paramètres système avancés.
  2. Dans l'onglet Avancé de la boîte de dialogue Propriétés système, cliquez sur Variables d'environnement.
  3. Dans la section "Variables utilisateur", cliquez sur Nouveau et créez une variable d'environnement avec les paramètres suivants:
     • Variable : APIC_DESIGNER_CREDENTIALS
     • Valeur: <designer_credentials_file_path>\designer_credentials.json où <designer_credentials_file_path> est l'emplacement où vous avez stocké le fichier designer_credentials.json .
  4. Cliquez sur OK pour enregistrer la nouvelle variable d'environnement, puis quittez la boîte de dialogue.
• Créez une variable d'environnement temporaire qui ne sera utilisée que lors de l'exécution de l'application API Designer.

  Les étapes suivantes doivent être effectuées chaque fois que vous démarrez API Designer:

  1. Ouvrez l'invite de commande Windows.
  2. Exécutez la commande suivante pour définir la variable d'environnement temporaire:

     set APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>\designer_credentials.json

     où <designer_credentials_file_path> est l'emplacement où vous avez stocké le fichier designer_credentials.json .

     Remarque: Laissez l'invite de commande ouverte pour l'étape suivante. Vous devez définir la variable temporaire et démarrer le concepteur d'API dans la même session de commande Windows.
  3. Exécutez à présent la commande suivante pour démarrer API Designer:

     C:\"Program Files\API Designer\API Designer.exe"

     Par défaut, API Designer est installé dans le dossier C:\"Program Files\API Designer , comme illustré dans l'exemple. Si vous l'avez installé dans un autre emplacement, utilisez votre propre emplacement dans la commande. Notez que le chemin et le nom de fichier sont placés entre guillemets car ils contiennent des espaces.

Mac OS X : créer une variable d'environnement en utilisant l'une des méthodes suivantes :

• Définissez une variable d'environnement globale permanente en exécutant la commande suivante:

  launchctl setenv APIC_DESIGNER_CREDENTIALS <designer_credentials_file_path>/designer_credentials.json

  où <designer_credentials_file_path> est l'emplacement où vous avez stocké le fichier JSON de données d'identification API Designer .
• Transmettez une variable d'environnement temporaire lors du démarrage d'API Designer à partir de la ligne de commande.

  Avec cette méthode, vous devez exécuter la commande suivante chaque fois que vous démarrez API Designer:

  APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>/designer_credentials.json open <designer_application_file_path>/'API Designer.app'

  où :
  • <designer_credentials_file_path> est l'emplacement dans lequel vous avez téléchargé le fichier JSON des données d'identification d' API Designer .
  • <designer_application_file_path> est l'emplacement dans lequel vous avez téléchargé et décompressé l'application API Designer .

apic client-creds:clear

Deleted client credentials

Lorsque vous effacez les données d'identification, veillez à ne pas vous connecter par inadvertance avec un ensemble de données d'identification incorrect (par exemple, celui d'une édition de produit ou d'un environnement différent). Il n'est pas nécessaire d'effacer les données d'identification d'API Designer.

apic client-creds:set <path_to_credentials>/credential.json

apic client-creds:set /Users/local_user/credential.json

apic login --server <platform-api-host-name> --sso

https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager

Context? provider

Un message de confirmation s'affiche pour indiquer que vous êtes maintenant connecté au serveur API Manager.

Pour vous déconnecter, exécutez la commande suivante:

apic logout --server <api-manager-host-name>

Successfully logged out of <api-manager-host-name>