Um die API als Entwickler bequem erkunden zu können, empfiehlt es sich einen API Client wie Postman zu verwenden. In diesen kann das openAPI-Dokument der Storefront API, welches unter
https://www.itscope.com/apidocs?group=storefront
heruntergeladen werden kann, geladen werden. Bei den Headers empfiehlt es sich, den Origin mitzugeben. Nicht alle Endpunkte der Storefront API benötigen den Origin-Header, es schadet allerdings nichts, ihn immer mitzugeben. Als Origin muss die Domain des Portals mitgegeben werden. Diese findet sich in der Portalverwaltung unter Einrichtung>Domain. Es ist egal, ob eine generierte Domain oder eine eigene Domain angegeben wird.
Mit diesen Requisiten kann nun eine Anfrage an den Branding-Endpunkt gestellt werden:
Die Informationen die zurückkommen sind geeignet, die Loginseite eines Portal zu befüllen: AGBs, Datenschutz, Impressum, Hintergrundbild usw. werden über diesen Endpunkt geholt. Ferner die Information, ob das Portal pausiert ist und die Information, ob eine Selbstregistrierung möglich ist. Wenn dies nicht der Fall ist, werden die dazugehörigen Endpunkte für Anmeldung oder Registrierung nicht funktionieren und entsprechende Fehler zurückgeben.
Da diese Daten für die Anmeldemaske benötigt werden, kann dieser Endpunkt ohne Authentifizierung aufgerufen werden. Damit ist der erste Schritt zur Nutzung der Storefront API getan.