APL Scheduler

Öffentliche API und Java-Client

Lernziel

Einen berechtigten Client mit dem öffentlichen Vertrag verbinden.

Praxisbeispiel

Mit Test-Webdienstkonto Unternehmen lesen und companyCode verwenden. In Eclipse JAR zum Build Path hinzufügen, Java 17 wählen.

Von Daten zum Ergebnis

  1. 1Lizenz
  2. 2Webdienst
  3. 3Token
  4. 4Anfrage

Referenz: `/api-docs`; Vertrag: `/openapi/v1.json`. Felder und Operationen richten sich nach der installierten Version.

  1. 1
    APL Integration und Webdienstkonto mit Unternehmen und Rollen sind erforderlich. Token über `/api/v1/auth/service-token` anfordern und als Authorization Bearer senden.
  2. 2
    Unternehmen über `companyCode` wählen. Der Server prüft Rechte und Unternehmen; keine Tokens zwischen Kunden teilen.
  3. 3
    Erstellen Sie in Eclipse ein Java-Projekt mit `java-client/src` oder fügen Sie das JAR zum Build Path hinzu. Java 17 wird benötigt, ohne externe Bibliotheken.
  4. 4
    Assistant, Factory View, Hilfe/Support und APL-Panel gehören nicht zur öffentlichen API. Keine internen Endpoints automatisieren oder Geheimnisse veröffentlichen.

Technische Referenz

Illustratives Beispiel: an installierten Vertrag anpassen und Geheimnisspeicher nutzen.

Java 17 / HTTP→Bearer · companyCode→APL Scheduler
GET /api/v1/companies
Authorization: Bearer <accessToken>

GET /api/v1/materials?companyCode=DEMO&section=articles&page=1&pageSize=25
Authorization: Bearer <accessToken>

// Java 17 · Eclipse: Java Build Path > Libraries
var client = new AplSchedulerClient(baseUrl);
client.authenticate(new ServiceCredentials(
    configuration, serviceUser, passwordFromSecretStore));
ApiResponse response = client.companies();
OpenAPI ↗OpenAPI JSON ↗

Vor dem Abschluss

OpenAPI passt zum Server, Lizenz, Unternehmen und Rolle stimmen. 401, 403, 409 und 429 behandeln, Schreibvorgänge nicht blind wiederholen.

Häufige Fragen

Option fehlt oder Bearbeitung nicht möglich

Unternehmen, Lizenz, Rechte und integrationsverwaltete Felder prüfen. Direkte URLs umgehen keine Einschränkungen.

Keine Datensätze gefunden

Filter löschen, Seite, Termine und Unternehmen prüfen. Es können keine zugänglichen Daten vorliegen; keine Testduplikate anlegen.

Gespeichert, aber erwartete Wirkung fehlt

Datensatz erneut öffnen und prüfen. Speichern veröffentlicht keine nötige Simulation. Vor erneutem Schreiben den ersten Vorgang prüfen.

Verwandte Anleitungen