Zum Hauptinhalt gehen

Verbindungen exportieren - OData API

JustPerform stellt seine Daten über eine standardisierte OData-API zur Verfügung, die es externen Systemen ermöglicht, Planungs- und Konsolidierungsdaten zu nutzen. Dies ermöglicht eine nahtlose Integration mit BI-Tools, benutzerdefinierten Anwendungen und anderen Unternehmenssystemen.

v25.12:  Sie können OData-Snippets über OData-Dienste bereitstellen, indem Sie auf ihre technische ID verweisen, und den Bericht über die API exportieren. Wie Sie OData-Snippets erstellen können, erfahren Sie unter OData-Schnipsel.

Aktivieren des OData-Exports

  1. OData-Dienst aktivieren

    1. Navigieren Sie zu Systemverwaltung

    2. API-Konfiguration auswählen

    3. OData-Dienst aktivieren

    4. Dienstendpunkt-URL konfigurieren

  2. Exponierte Entitäten definieren

    1. Auswählen von Datenmodellen zur Offenlegung

    2. Bestimmte Tabellen/Views auswählen

    3. Berechtigungen auf Feldebene festlegen

    4. Konfigurieren Sie Beziehungen

  3. Zugriffsberechtigungen festlegen

    1. Lese-/Schreibberechtigungen definieren

    2. Konfigurieren Sie die Sicherheit auf Entitätsebene

    3. Sicherheitsregeln auf Zeilenebene festlegen

    4. Abfragebeschränkungen aktivieren

API-Konfiguration

Dienst-Endpunkte

  • Dienst-Endpunkt: https://<API-justperform-instance>/justperform/Workspace/odata/$metadata

  • URL der Metadaten: https://<API-justperform-instance>/odata/SheetNames

Authentifizierungsmethoden

API-Schlüssel-Authentifizierung

  1. Generierung von API-Schlüsseln pro Kunde

  2. Verfallsrichtlinien festlegen

  3. Nutzung pro Taste überwachen

OAuth 2.0

  1. OAuth-Anbieter konfigurieren

  2. Client-Anwendungen einrichten

  3. Definieren von Bereichen und Berechtigungen

SSO-Integration

  1. Nutzung vorhandener SSO

  2. Benutzerberechtigungen zuordnen

  3. Sitzungsbasierter Zugang

Bewährte Praktiken für Verbraucher

Parameter

Bewährte Praktiken für Verbraucher

Effiziente Abfrage

  • Verwenden Sie $select, um Felder einzuschränken

  • Geeignete Filter anwenden

  • Paginierung implementieren

  • Zwischenspeichern häufig abgerufener Daten

Fehlerbehandlung

  • Umgang mit Ratenbegrenzungsantworten

  • Wiederholungslogik implementieren

  • Fehlgeschlagene Anfragen protokollieren

  • Fehlermuster überwachen

Optimierung der Leistung

  • Stapelverarbeitung verwenden

  • Minimierung von Rundreisen

  • Anfragen/Antworten komprimieren

  • Implementierung von Verbindungspooling

War dieser Beitrag hilfreich?

We're sorry to hear that.