Aufbau der API-URL

Die API-URL wird im oberen Bereich der API-Endpunkt-Dialoge angezeigt (außer in Dialog-Schritt "Allgemein").

Im Folgenden finden Sie einige Hinweise zum Aufbau der API-URL.

Bestandteile der API-URL

Methode

Basispfad

Parameter
variabel fix fix variabel variabel variabel
GET /api

/app/

 /GUID der Applikation /Pfad-Parameter ?/Query-Parameter

 

GUID der Applikation - Routing-Alias

Wenn Sie ein API-Request ausführen, können Sie die GUID der Applikation durch eine sprechende Bezeichnung, den Routing-Alias, ersetzen.

Detaillierte Informationen zum Routing-Alias finden Sie in Abschnitt Routing-Alias für API-URL vergeben.

Detaillierte Informationen zum Ausführen von API-Requests finden Sie in Abschnitt Requests ausführen.

 

Mindestens ein Pfad-Parameter

Eine API-URL muss mindestens einen Pfad-Parameter enthalten.

Als (ersten) Pfad-Parameter können sich statische, aussagekräftige Pfad-Parameter anbieten.

Beispiele

GET /api/app/1A2B3C4D5E/storedata/{store-id}

POST /api/app/1A2B3C4D5E/addstore/{store-id}/{store-manager}

Case-sensitiv

Die URL wird case-sensitiv interpretiert.

Eindeutigkeit der API-URL

Die API-Pfade müssen für jeden Endpunkt eindeutig sein.

D.h. die Angaben innerhalb von "Pfad-Parameter" dürfen nur einmal vorkommen.

Folgendes ist möglich:

/api/app/1A2B3C4D5E/parameter-1?{parameter-a}

/api/app/1A2B3C4D5E/parameter-2?{parameter-b}

/api/app/1A2B3C4D5E/parameter-1/parameter-2?{parameter-a}

/api/app/1A2B3C4D5E/parameter-1?{parameter-b}

Folgendes ist nicht möglich:

/api/app/1A2B3C4D5E/parameter-1?{parameter-a}

/api/app/1A2B3C4D5E/parameter-1?{parameter-b}