Configureren SAP API Management in SAP Cloud Platform

API's zijn de bouwblokken van de hedendaagse enterprise architectuur. Waar voorheen de architectuur voornamelijk werd gebaseerd op applicatiecomponenten, worden nieuwe oplossingen steeds meer gebaseerd op API-composities, vaak in de vorm van microservices. De rol van een API Management omgeving wordt steeds belangrijker. In het SAP portfolio hebben we dan over SAP API Management in SAP Cloud Platform. 

In deze blog de stappen om deze omgeving initieel in te richten. Zoals bij wel meer SAP Cloud Platform documentatie is de initiële inrichting moeilijk te vinden. En bij de open.sap training of youtube content wordt lang niet alles uitgelegd. En als het verkeerd is uitgevoerd, kost het onnodig veel tijd om te herstellen.

Bijvoorbeeld bij de foutmelding API_NOT_FOUND als de API Portal wordt gestart:

Toch is het opzetten van de API Management omgeving niet ingewikkeld.

In deze publicatie wordt uitgegaan van een niet-trial omgeving en dat er een gebruikerslicentie is voor het gebruik van API Management.

De Eerste Stappen

Als administrator inloggen in het cloud platform. API Management is als service te activeren in een subaccount van het type neo. Bij voorkeur wordt API Management in een apart subaccount gebruikt, zodat het een gescheiden onderdeel is van de rest van de cloud toepassingen. 

Navigeer naar 'Subaccounts' in het menu en maak een nieuw subaccount.

Kies voor type Neo.

Na [Create] wordt dit subaccount aangelegd. Na een paar seconden is ie er.

Bekijk via de [i] de technische info.

Onthoud de technical name. Deze naam wordt doorgaans gebruikt als een subdomein in de aanroep van cloud platform applicaties. Die gaan we straks weer gebruiken bij de initiële instellingen. Sluit deze popup.

Navigeer nu naar dit subaccount en kies in het menu [Services] en scroll naar beneden op zoek naar API Management.

Klip op de hyperlink [API Management]

[Enable] deze service.

Registreren Omgeving

Na het enablen van de service worden de hyperlinks onderin actief.

Kies [Access API Portal].

Vul de gewenste settings in. Bij Host alias kan je het technisch id van het subaccount gebruiken. Sluit af met de knop [Setup] rechtsboven. 

GOED LEZEN: Maak een OSS melding op component OPU-API-OD-OPS om deze omgeving te activeren door SAP! En nu maar hopen dat SAP dit snel oppakt...

Zodra het bevrijdende bericht is gekomen dat SAP de taak heeft volbracht, kan het toch nog enkele uren duren voordat de runtime van de API-portal helemaal goed werkt i.v.m. de replicatie van de nieuwe omgeving naar DNS-servers.

Gebruikersrollen

Intussen kunnen gebruikersrollen worden gekoppeld aan gebruikers.

• Bij de administrator die de basisconfiguratie heeft ingericht, kan de rol APIManagement.SelfService.Administrator worden verwijderd.
• De 'API developers' hebben extra rollen nodig om gebruik te kunnen maken van de API Portal waarin de API's beschikbaar worden gesteld.
• En ontwikkelaars die API's willen gaan consumeren hebben autorisaties nodig voor toegang tot de Developer Portal.

De on-line help documentatie is hiertoe prima. Let op, niet alle genoemde rollen zijn nodig, er zit overlap tussen, en soms kan het conflicten geven als er teveel rollen worden toegekend.

Connecties

Niet verplicht, maar wel handig als je een SAP backend systeem hebt, is om in de API Portal een service provider te definiëren. SAP Gateway voor OData koppelingen bijvoorbeeld. 

Ook dit is over het algemeen goed terug te vinden in online content. Bij on-premise omgevingen altijd eerst effe die cloud connector inrichten, alvorens een koppeling te maken.

LET OP: bij de initiële configuratie is op de achtergrond een destination DEST_CI aangelegd naar de developer portal. In die destination zit de user met password opgenomen als basic authentication. En aangezien je password geregeld wijzigt, zal ook die destination moeten worden onderhouden. Evt. pas je de wijze van authenticatie aan in die destination.

Ready for Launch!

De basisconfiguratie is afgerond nu. Gebruik de API Portal dus voor API provisioning en de API Developer Portal voor de consumption. Succes ermee!!