API Finder: Cómo conocer las API´s disponibles y su documentación detallada

Conozca cómo acceder a toda la información para utilizar API's en sus programas aprovechando la facilidad del API Finder de los "Buscadores y Asesores" en el IBM i Knowledge Center (anteriormente Information Center)

Nota de UPDATE: IBM Information Center ahora es IBM Knowledge Center. 

Para acceder: https://www.ibm.com/support/knowledgecenter/es/ssw_ibm_i, donde hay que seleccionar la versión de i con la que se quiere trabajar. Por lo tanto las pantallas mostradas en el presente tip difieren en algo a lo que se muestra actualmente en el portal oficial, sin embargo los conceptos no cambian y se llega a la misma información. 

Las API (Application Programming Interface) son un recurso de programación avanzada presente casi en cualquier plataforma de desarrollo de cierta jerarquía. Conceptualmente, las API´S consisten en “subrutinas” suministradas por los proveedores de sistemas operativos y lenguajes de programación para acceder a funciones de bajo nivel, acceder a recursos del sistema no manejables mediante sentencias de programación convencionales, o automatizar desde un programa comandos que habitualmente se ejecutan en entornos interactivos.  En AS/400 las API´s se materializan a través de un conjunto de objetos *PGM, residentes en QSYS.

Al igual que las API´s de Windows, de Unix, o de cualquier otra arquitectura, las Api´s de AS/400 se trabajan invocándolas desde los lenguajes de alto nivel, con los parámetros adecuados.

Las API´s están dirigidas a programadores experimentados, y no reemplazan a los comandos CL sino que los complementan. Por ejemplo, existen funciones no abarcadas por comandos CL, que solamente a través de API´s pueden realizarse (por ejemplo, recibir entradas desde colas de datos, implementar SQL remoto). Otras API´s, en cambio, realizan tareas disponibles mediante comandos interactivos pero de una manera más eficiente y flexible. Por ejemplo, QUSRSPLA dentro de un programa reemplaza al comando interactivo DSPPLFA para obtener esa misma información dentro de un programa CL, y recibir los datos en una variable para ser utilizados luego por el programa.

La biblioteca QUSRTOOL provista por IBM con el OS/400 incluye varios ejemplos de comandos y programas en lenguaje de alto nivel que hace uso de API´s del sistema. Estas pueden usarse tal como están o servir de base para nuevos desarrollos.

Clasificación de API´s

Las Api están organizadas en categorías dependiendo del tipo de acción que realizan, y la función del sistema con la que se relacionan. Por ejemplo, existe un conjunto de API´s para funciones de Backup y Recuperación, otro para funciones de  Configuración, manejo de trabajos, comunicaciones, manejo de Fecha y Hora, administración del spool, etc. A su vez, en cada categoría pueden distinguirser:

• “List” APIs, o “Retrieve” APIs, que extraen información sobre algún aspecto del sistema para entregarlo al programa de aplicación.
• “Create”, “change”, o “delete” APIs, que accionan sobre los objetos del sistema.
• Otras APIs, que ejecutan una variedad de acciones en el sistema.

Documentación: La clave para usar API´s

Como ocurre con cualquier subrutina, para poder hacer uso de API´s es esencial:

• Conocer su propósito y su nombre, en otras palabras, saber que existe,
• Contar con la documentación adecuada para implementarlas: Parametros, mensajes de error monitoreables, formatos disponibles para los datos obtenidos, estructura del string de datos de salida, etc.

En virtud de ello, es fundamental para cualquier programador contar con los medios de acceso a la lista de API´s disponibles y a su documentación detallada.

API Finder. Conociendo las API´s a través del IBM i Knowledge Center

IBM provee distintas fuentes de acceso a información de referencia sobre las API´s disponibles, en la documentación del sistema.

La manera más fácil y eficiente hoy en día de acceder a cualquier información del sistema IBM i -AS400-iSeries es a través del sitio oficial de información de IBM: "IBM i Knowledge Center". IBM ofrece en la Web el mencionado Knowledge Center, un portal de toda la información oficial disponible para esta plataforma, para todas las versiones soportadas (V5R4, IBM i 6.1, IBM i 7.1, IBM i 7.2, IBM i 7.3).

Además de la navegación convencional a través de los menúes a la izquierda, a partir de la versión de IBM i 6.1, en el sitio  IBM Information Center para iseries, se ha incorporado un conjunto de  "Buscadores y Asesores " , que permite acceder a ciertas búsquedas específicas y referenciales,  sin necesidad de navegar el sitio. Como ya fue tratado en otros tips, entre los “Buscadores y Asesores” hay un buscador de Valores del Sistema, de códigos SRC del IPL, comandos CL y su sintáxis, entre otros  y, existe también el llamado Buscador de API o API Finder.

La siguiente es la URL para acceder al Information Center de IBM iSeries: http://www.ibm.com/support/knowledgecenter/ssw_ibm_i/welcome

Desde allí, seleccionar la versión del sistema operativo IBM v5R4, i 6.1, 7.1, 7.2 o 7.3 para tener la posibilidad de acceder al API Finder mencionado previamente, como lo muestra la siguiente pantalla:

Alternativamente, si buscamos por nombre parcial. En este caso utilizamos la sección "Find by name", que puede combinarse o no con las otras. Por ejemplo, podemos pedir todas las API´s que contienen QCMD como parte del nombre, relacionadas con la categoría de "Configuración".

Finalmente, se llega a la documentación de la API seleccionada:

Consideraciones Adicionales

• También es posible, usando la sección de "Find by name", buscar API´s por su descripción, por ejemplo, introduciendo "Spool file attributes", etc.
• Es importante tener en cuenta que el tipo de información que brinda el API Finder, es información de REFERENCIA, es decir, no incluye una introducción al sistema ni a las API´s, ni una guía de cómo escribir aplicaciones. Las API´s están destinadas a programadores de nivel avanzado.
• Por el momento, el API Finder no está traducido al castellano

Copyright 2012 - Teknoda S.A.