Zum Inhalt springen
SPARETECH-API
SPARETECH-Team

SPARETECH API

Inhaltsübersicht

 

Allgemeine Informationen

Die SPARETECH-API ist eine Lösung, die eine nahtlose Synchronisation von Daten zwischen der SPARETECH-Anwendung und verschiedenen anderen Systemen, einschließlich ERP und MDM, ermöglicht und den Benutzern eine effiziente und problemlose Synchronisation bietet.

Unsere API basiert auf REST-Designprinzipien und ermöglicht Ihnen die Verwaltung Ihrer Materialstammdaten. Sie verfügt über ressourcenorientierte URLs, verwendet standardmäßige HTTP-Methoden und akzeptiert und liefert JSON-kodierte Anfrage- und Antwortkörper. Die Autorisierung erfolgt mit standardmäßigen JSON-Web-Tokens (JWT).


SPARETECH Arbeitsablauf-APIs


Ressourcen Mit dieser API können Sie
Schema Abrufen des Materialstamm-Konfigurationsschemas, das für weitere Zuordnungen verwendet werden kann
Erstellung von Materialien Synchronisieren Sie alle Erstellungsabsichten für die Materialstammerstellung in Ihrem ERP oder MDM
Wesentliche Änderung Synchronisieren Sie alle Änderungsabsichten für Materialstammänderungen in Ihrem ERP oder MDM
Erweiterung des Materials Synchronisieren Sie alle Erweiterungsabsichten für die Materialstammerweiterung in Ihrem ERP oder MDM
Aktualisierung des Materialstamms Aktualisieren Sie den Materialstamm in SPARETECH auf Basis der von Ihrem ERP initiierten Änderungen.


Sicherheit und Authentifizierung

Unsere API verwendet den Client Credentials Flow für die Authentifizierung und JWT-Tokens für die Autorisierung. SPARETECH stellt Ihre Client Credentials, ein Paar aus Client ID und Client Secret, für jede Umgebung bereit. Weitere Einzelheiten zur Authentifizierung Ihrer Anwendung finden Sie unter Abrufen eines Zugriffstokens unten

Credential-Flow

‍

‍

Test und Experiment

Wir stellen Ihnen eine Sandbox-Umgebung zur Verfügung, in der Sie Testdaten erstellen und Ihre Integration sicher ausprobieren können, ohne dass Ihre Live-Daten beeinträchtigt werden. Verwenden Sie die Anwendung, um Ihre Testdaten zu verwalten, und rufen Sie dann die API auf, um Ihre Integration zu testen.

Los geht's

Zugriffstoken erhalten

Um auf Ihre Daten zuzugreifen, müssen Sie zunächst Ihre Client-Anmeldedaten gegen ein Zugriffstoken austauschen. Dies geschieht durch den Aufruf unseres Authentifizierungsendpunkts.

Beispiel


$ curl 'https://sync.sandbox.sparetech.io/v1/auth' --request POST \ 

--header 'content-type: application/json' \ 

--data '{ "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET" }'

‍

Abrufen einer Liste von Erstellungsabsichten

Da Sie nun ein Zugriffstoken haben, können Sie Erstellungsabsichten anfordern.

$ curl 'https://sync.sandbox.sparetech.io/v1/creation-intents' \ 
--header "Authorization: Bearer <access_token>"

‍

Ihre Antwort sollte in etwa so aussehen, was Ihnen zeigt, dass eine Absicht vorliegt:

 { 

 "hasMore": false, 

   "totalCount": 1, 

   "limit": 10, 

   "creationIntents": [ 

      { 

        "id": "904134", 

    "createdAt": "2022-12-10T12:05:12Z", 

    "status": "Exported", 

    "metadata": { 

     "MANU": "Sparetech", 

     "ART_NUM": "SED1234", 

       "TYP":  "TYP_1234", 

    "DESC":  "Material Description" 

        } 

     }

   ]

}

‍

Der Inhalt Ihres creationIntents-Metadatenobjekts hängt von Ihrer eigenen Exportkonfiguration ab. Da wir nur nicht leere Felder zurückgeben, können Sie über den Endpunkt Exportschema auf das vollständige Objekt zugreifen.

‍

Bestätigen Sie eine Erstellung

Nachdem Sie Ihre verfügbaren Erstellungsabsichten aufgelistet haben, können Sie diese bearbeiten und in Ihr System schreiben. Anschließend sollten Sie den Endpunkt Anlegen bestätigen aufrufen, um SPARETECH mitzuteilen, dass Sie das Material bearbeitet haben. Auf diese Weise stellen Sie sicher, dass Ihre Materialstammdaten zwischen den beiden Systemen synchronisiert sind.

$ curl "https://sync.sandbox.sparetech.io/v1/creation-intents/904134/confirm" \
-X POST \ 
-H "Authorization: Bearer <access_token>" \ 
-d "{ \"materialNumber\": \"<YOUR_INTERNAL_REFERENCE>\" }"

 

YOUR_INTERNAL_REFERENCE ist der Wert, den Sie in Ihrem System als Identifikator für dieses Material verwenden.

 

Änderung und Erweiterung beabsichtigt

Bei Änderungsintentionen und Erweiterungsintentionen ist der Prozess sehr ähnlich! Sie müssen lediglich die verfügbaren Intents auflisten, sie auf Ihr System anwenden und die Bestätigungsendpunkte aufrufen, um die beiden Systeme auf dem gleichen Stand zu halten. Spezifische Informationen über diese beiden Prozesse finden Sie in unserer Dokumentation.

Empfehlungen

  • Speichern Sie Ihre Anmeldedaten und Token sicher und geben Sie sie nur an Dienste weiter, die sie benötigen.
  • Reduzieren Sie unnötige Anrufe, indem Sie das vom Autorisierungsserver erhaltene Zugriffstoken speichern.
  • Für SAP-Kunden, die SAP NetWeaver verwenden: Überprüfen Sie Ihre Version, bevor Sie die Konfiguration in PI/PO starten und ob der REST Adapter den Authentifizierungsfluss für OAuth 2.0 unterstützt.


API-Dokumentation

Die technische API-Dokumentation finden Sie auf dieser Seite.

‍

Weitere Beiträge