Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Aufrufen einer API

Nach der Aktivierung der API können Sie sie unter Verwendung der OData-Syntax aufrufen.

Allgemeine Syntax

Für den Aufruf Ihrer API benötigen Sie Folgendes:
  • Die URL der API. Sie besteht aus einer Basis-URL und dem bei der API-Aktivierung generierten Pfad der API. Wenn Sie eine Moteur Cloud pour le design verwenden, wird diese URL auf der API-Registerkarte Ihres Datensatzes angezeigt. Wenn Sie eine Moteur distant Gen2 verwenden, wird nur der API-Pfad angezeigt. Wenden Sie sich an Ihren Administrator, um die Basis-URL zu erhalten.
  • Sie müssen /apis/ zwischen der Basis-URL und dem API-Pfad einfügen. Eine URL-Vorlage für einen API-Aufruf wäre beispielsweise <base_url>/apis/<api_path>.
  • Die bei der Erstellung des zu verwendenden Consumers festgelegten Anmeldedaten.

Beim Aufruf einer API auf einer Moteur Cloud pour le design müssen Sie folgende Einschränkungen berücksichtigen:

  • Die Aufrufrate ist auf 30 Requests pro Sekunde und pro eingehender Client-IP begrenzt.
  • Maschinen im selben VPN-Netzwerk werden als eine Client-IP angesehen, da sie dieselbe öffentliche IP verwenden.
InformationshinweisWarnung: Aufgrund eines temporären Problems werden Spalten, die einen bestimmten semantischen Typ im Quelldatensatz verwenden, in den Typ string (Zeichenfolge) konvertiert, wenn sie über die API aufgerufen werden:
  • Boolesche Werte: boolean
  • Daten und Uhrzeiten: dates
  • Ganzzahlen: integer und Dezimalwerte (für Oracle)
  • Lange Ganzzahlwerte: integer, insbesondere SQL bigint

Testen in einer persönlichen Umgebung

Als Beispiel dient ein Datensatz mit Basiskundendaten, der über eine Verbindung erstellt wurde, die auf einer auf Ihrem persönlichen Gerät installierten Moteur distant Gen2 gehostet wird. Sie aktivieren eine API für die Entitätsgruppe namens customers (Kunden) sowie den API-Pfad customers-api-2PZPTB (Kunden-API-2PZPTB) und können die API dann mit dem gewünschten Tool über die folgende URL aufrufen:

http://localhost:8080/apis/customers-api-2PZPTB/customers

Da die API auf Ihrem persönlichen Gerät gehostet wird, lautet die Basis-URL der API ganz einfach http://localhost:8080. Dieser Request gibt die Daten des gesamten Datensatzes zurück.

Beispiel für einen API-Aufruf in einer Produktionsumgebung

Wenn Sie dieselbe API in einem Produktionskontext aufrufen, ändern sich einige Parameter. Daraus ergibt sich die folgende URL:

https://mycompany.com/apis/customers-api-2PZPTB/customers
  • Die API sollte mit HTTPS gesichert werden. Unter „Sichern einer API“ finden Sie Informationen zur Konfiguration von HTTPS.
  • Die Basis-URL wurde von Ihrem Administrator entsprechend der Firmendomäne oder einem anderen benutzerspezifischen Format eingerichtet.

Der Rest der URL, insbesondere der Teil /apis/, und der API-Pfad bleiben unverändert.

Weitere Beispiele für Aufrufe unter Verwendung der unterstützten OData-Expressivität finden Sie unter „API-Expressivität“.

Hat diese Seite Ihnen geholfen?

Wenn Sie Probleme mit dieser Seite oder ihren Inhalten feststellen – einen Tippfehler, einen fehlenden Schritt oder einen technischen Fehler –, teilen Sie uns bitte mit, wie wir uns verbessern können!

Geben Sie hier Ihr Feedback ab