Configuración del kit de herramientas de API Connect

Instale el kit de herramientas que proporciona los mandatos de CLI y la interfaz de usuario de API Designer para IBM® API Connect.

Acerca de esta tarea

Con el kit de herramientas, puede elegir cómo desea trabajar con las API:

API Designer ofrece una interfaz gráfica similar a API Manager. Puesto que trabaja localmente, no todas las características de API Manager están disponibles en API Designer.
La CLI (interfaz de línea de mandatos) permite trabajar en una ventana de mandatos en lugar de utilizar la interfaz gráfica.

La configuración del kit de herramientas implica las tareas siguientes:

Descargar el kit de herramientas
Iniciar la sesión en el kit de herramientas

Descargar el kit de herramientas

Acerca de esta tarea

Para instalar el kit de herramientas, descargue el archivo comprimido que sea apropiado para la opción del kit de herramientas y la plataforma que haya elegido y a continuación, extraiga el contenido en una ubicación seleccionada en la máquina local. El archivo comprimido contiene un archivo ejecutable para ejecutar mandatos de CLI y, si elige la opción CLI + Designer , un archivo ejecutable para iniciar la aplicación API Designer.

Procedimiento

Descargue el kit de herramientas desde el Gestor de API en IBM API Connect.
1. Inicie sesión en API Manager utilizando su dirección IBMid.
2. En la página de inicio de API Manager, haga clic en el enlace Herramientas para descargar.
3. En la sección "Paso 1: Descargar kit de herramientas" de la ventana Instalar API Connect Toolkit , seleccione el tipo de paquete que desea descargar y pulse el enlace correspondiente a su sistema operativo.
  - CLI: proporciona un entorno de línea de mandatos para trabajar con IBM API Connect.
  - CLI + Designer: proporciona un entorno de línea de mandatos para trabajar con IBM API Connect, además de la interfaz de usuario de API Designer .
En la sección "Paso 2: Descargar credenciales", descargue los dos archivos de credenciales:
1. Pulse la opción Descargar para Credencial y guarde el archivo credentials.json en el sistema de archivos local.
2. Pulse la opción Descargar para las Credenciales de API Designer y guarde el archivo designer_credentials.json en el sistema de archivos local.
En su ordenador, localice el archivo comprimido del kit de herramientas descargado y extraiga el contenido a una carpeta de su elección.
El contenido del archivo depende de la opción del kit de herramientas y de la plataforma elegida, como se indica a continuación:
- El archivo apic-slim o apic-slim.exe es la CLI para IBM API Connect.
- El archivo apic o apic.exe es la CLI para IBM API Connect.
  Sugerencia: Si está utilizando la opción CLI , si cambia el nombre del archivo apic-slim por apic, o el archivo apic-slim.exe por apic.exe, puede ejecutar los mandatos de CLI exactamente como se documenta, copiar y pegar los mandatos de ejemplo de la documentación y utilizar los scripts de mandatos tal cual si posteriormente pasa a la opción CLI + Designer .
- El archivo api_designer-platform es la aplicación de interfaz de usuario de API Designer para la plataforma especificada.
Ejecute la CLI.
- Para las plataformas Mac OSX o Linux® , realice los pasos siguientes:
  1. Abra una instancia de terminal y navegue hasta la carpeta en la que extrajo el contenido del archivo comprimido del kit de herramientas.
  2. Haga que el archivo de CLI sea un archivo ejecutable especificando el mandato siguiente:
```
chmod +x download_name
```
    Donde nombre_descarga es el nombre del archivo de kit de herramientas que ha descargado, ya sea apic o apic-slim.
  3. Ejecute los mandatos de CLI tal como se indica a continuación
```
./apic command_name_and_parameters
```
    o
```
./apic-slim command_name_and_parameters
```
    Para obtener detalles de los mandatos de CLI, consulte la documentación de referencia de CLI del kit de herramientas.
- Para la plataforma Windows, siga estos pasos:
  1. Abra un símbolo del sistema y vaya a la carpeta en la que extrajo el contenido del archivo comprimido del kit de herramientas.
  2. Ejecute los mandatos de CLI tal como se indica a continuación
```
apic command_name_and_parameters
```
    o
```
apic-slim command_name_and_parameters
```
    Para obtener detalles de los mandatos de CLI, consulte la documentación de referencia de CLI del kit de herramientas.
Sugerencia: Añada la ubicación de carpeta del archivo CLI a la variable PATH para poder ejecutar mandatos CLI desde cualquier lugar del sistema de archivos.
Instalar las credenciales del kit de herramientas:
Instale las credenciales del kit de herramientas abriendo una ventana de terminal (o un indicador de mandatos de Windows) y ejecutando el mandato siguiente:
```
apic client-creds:set <toolkit_credentials_file_path>/credentials.json
```
donde < vía_archivo_credenciales > es la ubicación donde ha descargado el archivo JSON de credenciales del kit de herramientas. El kit de herramientas utiliza estas nuevas credenciales para autenticarse con el servidor que aloja el Gestor de API.
Instalar las credenciales de API Designer:
Instale las credenciales de API Designer estableciendo la variable de entorno APIC_DESIGNER_CREDENTIALS en la ubicación de descarga de credenciales, utilizando el mecanismo adecuado para su sistema operativo.

Windows: cree una variable de entorno utilizando uno de los métodos siguientes.
- Cree una variable de entorno permanente para que pueda iniciar API Designer desde cualquier ubicación del sistema:
  1. Abra la página Variables de entorno: pulse Inicio > Valores > Sistema y, en la sección "Valores relacionados" de la página, pulse Valores avanzados del sistema.
  2. En la pestaña Avanzadas del cuadro de diálogo Propiedades del sistema, pulse Variables de entorno.
  3. En la sección "Variables de usuario", pulse Nuevo y cree una variable de entorno con los valores siguientes:
    - Variable: APIC_DESIGNER_CREDENTIALS
    - Valor: <designer_credentials_file_path>\designer_credentials.json donde <designer_credentials_file_path> es la ubicación donde ha almacenado el archivo designer_credentials.json .
  4. Pulse Aceptar para guardar la nueva variable de entorno y, a continuación, salga del recuadro de diálogo.
- Cree una variable de entorno temporal que sólo se utilizará mientras ejecuta la aplicación API Designer.
  Los pasos siguientes se deben realizar cada vez que inicie API Designer:
  1. Abra el indicador de mandatos de Windows.
  2. Ejecute el mandato siguiente para establecer la variable de entorno temporal:
```
set APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>\designer_credentials.json
```
    donde <designer_credentials_file_path> es la ubicación donde ha almacenado el archivo designer_credentials.json .
    
    Nota: Deje abierto el indicador de mandatos para el paso siguiente. Debe establecer la variable temporal e iniciar API Designer dentro de la misma sesión de mandatos de Windows.
  3. Ahora ejecute el mandato siguiente para iniciar API Designer:
```
C:\"Program Files\API Designer\API Designer.exe"
```
    De forma predeterminada, API Designer se instala en la carpeta C:\"Program Files\API Designer tal como se muestra en el ejemplo. Si lo ha instalado en una ubicación diferente, utilice su propia ubicación en el mandato. Tenga en cuenta que la vía de acceso y el nombre de archivo están entre comillas porque contienen espacios.
Mac OS X : cree una variable de entorno utilizando uno de los siguientes métodos:
- Establezca una variable de entorno global permanente ejecutando el mandato siguiente:
```
launchctl setenv APIC_DESIGNER_CREDENTIALS <designer_credentials_file_path>/designer_credentials.json
```
  donde <designer_credentials_file_path> es la ubicación donde ha almacenado el archivo JSON de credenciales de API Designer .
- Pase una variable de entorno temporal al iniciar API Designer desde la línea de mandatos.
  Con este método, debe ejecutar el mandato siguiente cada vez que inicie API Designer:
```
APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>/designer_credentials.json open <designer_application_file_path>/'API Designer.app'
```
  donde:
  - <designer_credentials_file_path> es la ubicación en la que ha descargado el archivo JSON de credenciales de API Designer .
  - <designer_application_file_path> es la ubicación en la que ha descargado y descomprimido la aplicación API Designer .

Iniciar la sesión en el kit de herramientas

Acerca de esta tarea

Inicie sesión en el servidor de gestión de IBM API Connect con el kit de herramientas.

Procedimiento

Borre las credenciales de kit de herramientas de cualquier inicio de sesión anterior ejecutando el mandato siguiente:
```
apic client-creds:clear
```
La respuesta confirma que las credenciales se han suprimido:
```
Deleted client credentials
```
Borrar las credenciales garantiza que no iniciará la sesión involuntariamente con un conjunto de credenciales incorrecto (por ejemplo, de un entorno o release de producto diferente). No es necesario borrar las credenciales de API Designer.
Establezca las credenciales que desea utilizar ahora ejecutando el mandato siguiente:
```
apic client-creds:set <path_to_credentials>/credential.json
```
donde <path_to_credentials> es la ubicación del archivo credential.json que desea utilizar. Por ejemplo:
```
apic client-creds:set /Users/local_user/credential.json
```
Inicie sesión ejecutando el mandato siguiente:
```
apic login --server <platform-api-host-name> --sso
```
Donde <platform-api-host-name> es la parte del nombre de host URL del servidor que aloja el Gestor de API (el "servidor de gestión"). Para determinar el nombre de host, abra API Manager en un navegador y copie el nombre de host de URL en la barra de direcciones (empezando después de " https:// " y terminando antes de "/manager") como se muestra en el siguiente ejemplo:
```
https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager
```
Cuando el kit de herramientas solicite el contexto, escriba provider y pulse Intro:
```
Context? provider
```
Se muestra un mensaje de confirmación para indicar que ha iniciado sesión en el servidor de API Manager.

Para cerrar la sesión, ejecute el mandato siguiente:
```
apic logout --server <api-manager-host-name>
```
La respuesta confirma que ha finalizado la sesión:
```
Successfully logged out of <api-manager-host-name>
```