API Dienst URL im Jitterbit API-Manager

Einführung

Custom APIs, OData-Dienste und Proxy-APIs, die mit Jitterbit API-Manager erstellt wurden werden über die Service URL einer API aufgerufen. Auf dieser Seite werden die Teile einer API Service URL beschrieben.

Die Service-URL einer API ist die URL, die zum Verwenden der API mit der konfigurierten Authentifizierungsmethode verwendet wird.

Die Service URL kann von einer Anwendung aufgerufen werden, oder Sie können die URL - wenn die API GET unterstützt - in einen Webbrowser einfügen, um die API manuell zu nutzen.

Format einer API Dienst-URL

Alle API Dienst-URLs folgen demselben Format. Proxy-APIs können zusätzliche Dienstpfadparameter haben:

Custom API or OData service

<Protocol>://<Base URL>/<Environment URL Prefix>/<Version>/<Service Root>

Proxy API

<Protocol>://<Base URL>/<Environment URL Prefix>/<Version>/<Service Root>/<Service Path>

Dies sind typische Beispiele für die Service URL einer API:

Custom API or OData service

https://JBExample123456.jitterbit.net/Development/1/customer

Proxy API

https://JBExample123456.jitterbit.net/Development/1/dog/pet/{petId}/uploadImage

Teile einer API Dienst-URL

Die Service-URL jeder API wird automatisch aus diesen Teilen erstellt:

Teil	Beispiel	Beschreibung
Protokoll	`https`	Das Protokoll ist immer `https`.
Basis URL	`JBExample123456.jitterbit.net`	Die Basis URL. Die standardmäßige Basis URL besteht aus dem Harmony-Organisationsnamen, der Harmony-Organisations-ID und dem Harmony Regionaldomänennamen: `<Harmony Organization Name><Harmony Organization ID>.<Harmony Region Domain Name>` Um einen benutzerdefinierten Domänennamen als Basis URL für Ihre veröffentlichten APIs zu verwenden, können Sie eine der folgenden Methoden nutzen: Verwenden Sie ein Drittpartei wie Cloudflare oder einen DNS-Proxy, um einen benutzerdefinierten Domänennamen an die Basis URL Ihres API Gateways Route. Verwenden Sie ein privates Jitterbit API Gateway mit einem benutzerdefinierten Domänennamen (verwenden Sie diese Option, wenn Sie ein privates API Gateway mit einem einzigen Mandanten benötigen).
Name der Harmony Organisation	`JBExample`	Der Name der Harmony-Organisation. Für Testlizenzen, die vor 10.64 / 11.2 initiiert wurden wird dem Organisationsnamen das Wort `TRIAL`. Sie können den Jitterbit-Support kontaktieren das Wort haben `TRIAL` aus der Basis URL der Organisation entfernt. Beachten Sie, dass alle bestehenden Verwendungen der Service-URL davon betroffen sind.
Harmony-Organisations-ID	`123456`	Die Harmony Organisations-ID.
Domänenname der Harmony Region	`jitterbit.net`	Die Harmony Domänenname der Harmony-Organisation: APAC: `jitterbit.cc` EMEA: `jitterbit.eu` NA: `jitterbit.net`
Umgebungs URL -Präfix	`Development`	Das URL Präfix, das in der Konfiguration der Umfeld angegeben ist, in der die API konfiguriert wird (siehe das Feld URL Präfix in Umgebungen).
Version	`1`	Die Version, die in der Konfiguration der benutzerdefinierten API, des OData Dienstes oder der Proxy-API in diesen Schritten angegeben wurde: Schritt 1: Einstellungen von benutzerdefinierter API Konfiguration Schritt 1: Einstellungen von OData Dienstkonfiguration Schritt 1: Grundeinstellungen der Proxy-API Konfiguration
Dienststamm	`customerdog`	Der Service Root wird in der Konfiguration der benutzerdefinierten API, des OData Dienstes oder der Proxy-API in diesen Schritten angegeben: Schritt 1: Einstellungen von benutzerdefinierter API Konfiguration Schritt 1: Einstellungen von OData Dienstkonfiguration Schritt 1: Grundeinstellungen von Proxy-API Konfiguration
Servicepfad (nur Proxy API)	`pet/{petId}/uploadImage`	Der in der Konfiguration der Proxy API in diesem Schritt angegebene Pfad: Schritt 3: Dienste und Methoden definieren der Proxy-API Konfiguration