Documentació del servei de l'API Manager Corporatiu

Es posen a disposició els següents manuals d’usuari on es detallen les característiques i metodologia de treball del servei d’API Manager:

Proveïdors

A continuació, hi ha tots els recursos que pugui necessitar un usuari proveïdor que vulgui realitzar desenvolupaments d’APIs i productes a la plataforma d’API Manager Corporatiu.

• Manual del proveïdor d’APIs: conceptes generals del servei APIM i com publicar les APIs.
• Guia de desenvolupament d’APIs i ús de les plantilles: document l’objectiu principal del qual és proporcionar una guia completa del desenvolupament i ús de la plantilla d’ APIs definida, amb un enfocament específic en la millora i optimització del treball dels desenvolupadors dins de l’ API Manager de CTTI.
• Guia d’instal·lació i configuració de LTE: document que ensenya a instal·lar i configurar l’entorn local de l’IBM API Connect, que consisteix del Toolkit (API Designer) i LTE (Local Testing Environment).
• Plantilla API OpenAPI 3.0: plantilla duna API en format OpenAPI 3.0.
• Plantilla API OpenAPI 2.0: plantilla duna API en format OpenAPI 2.0.
• Plantilla Producte: plantilla d’un producte.
• Estàndards de Nomenclatura: estàndards de nomenclatura per als desenvolupaments d’APIs i productes.
• Bones Pràctiques: bones pràctiques en els desenvolupaments d’APIs i productes.
• DT Polítiques i Extensions: disseny tècnic de les polítiques i extensions personalitzades que poden ser utilitzades a l’entorn de l’API Manager Corporatiu.
• Guia pujada fitxers Gateways: guia per fer el procediment de pujada de fitxers als gateways de l’entorn de l’API Manager Corporatiu, pas necessari per poder fer ús de la política personalitzada ctti-get-variables.
• Manual importació polítiques entorn local: manual d’importació de polítiques personalitzades a l’entorn local, que fa servir el Toolkit i l’LTE de l’IBM API Connect.
• Guia de desplegament de recursos a l’entorn local: guia de desplegament de recursos als gateways de l’entorn local, format pel Toolkit i l’LTE de l’IBM API Connect.
• Guia de desplegament: guia de desplegament d’APIs i productes als entorns de l’API Manager Corporatiu.

Consumidors

A continuació, hi ha tots els recursos que pugui necessitar un usuari consumidor que vulgui consumir APIs i productes a la plataforma d’API Manager Corporatiu.

• Manual del consumidor d’APIs: conceptes generals del servei APIM, com subscriure’s i consumir les APIs.

Manuals d’operacions

• Manual d’operatives de l’oficina tècnica d’API Manager: document que descriu les operatives que l’oficina tècnica d’API Manager podria fer durant l’acompanyament de projectes o el manteniment del servei dins de la plataforma SaaS d’API Connect.
• Manual seguretat APIM: conceptes generals de la seguretat del api manager.