Zum Hauptinhalt springen

Benutzerdefinierte Einstellungen

Die API für benutzerdefinierte Einstellungen ermöglicht es Ihnen, beliebige Einstellungswerte für einen bestimmten Benutzer zu speichern. Der vorgesehene Anwendungsfall für diese API sind Integrationsaufgaben.

Hinweis

Benutzerdefinierte Einstellungen überschneiden sich nicht mit iCL-Einstellungen. Sie werden separat gespeichert. Daher können Sie mit der API für benutzerdefinierte Einstellungen keine bestehenden Benutzereinstellungen ändern.

Anwendungsfall: Integrationsaufgaben​

In einem Integrationsszenario möchten Sie vielleicht einige Informationen für Ihren Service-Benutzer speichern, die jedes Mal, wenn der Integrationsprozess läuft, abgerufen werden können.

Sie möchten zum Beispiel Bestellungen in Ihrem Altsystem mit iCL Portal synchronisieren, wo Sie Bestellungen als Inhaltstyp Bestellung speichern. In diesem Szenario speichern Sie die letzte Auftragsnummer, die von Ihrer Integration verarbeitet wurde. Auf diese Weise kann der Integrationsprozess jedes Mal, wenn er läuft, dort weitermachen, wo er aufgehört hat, und muss nicht alle Bestellungen im System immer wieder neu verarbeiten. Das folgende Diagramm veranschaulicht dieses Szenario:

  1. Sie fragen die Einstellungs-API ab, um zu prüfen, ob die Einstellung last_processed_ordernumber verfügbar ist.
  2. Dann verwenden Sie die last_processed_ordernumber, um eine neue Bestellung aus Ihrem Altsystem zu holen, wodurch Sie auch den neuen Wert für last_processed_ordernumber erhalten...
  3. ...und importieren Sie die Aufträge in das iCL Portal.
  4. Schließlich speichern Sie die neue last_processed_ordernumber.
Servicekonto-Authentifizierung

Um Ihr Servicekonto zu authentifizieren, verwenden Sie den OAuth 2.0 Client Credentials Flow wie hier beschrieben

1. Erstellen/Aktualisieren einer benutzerdefinierten Einstellung​

Um eine benutzerdefinierte Einstellung zu erstellen oder zu aktualisieren, verwenden Sie den folgenden Endpunkt:


POST https://dev.iclportal.com/api/settings/customusersetting HTTP/1.1
Authorization: Bearer ..the auth_token...

{
  "name": "last_processed_ordernumber",
  "value": { 
     "ordernumber":122
   }
}

2. Abrufen einer benutzerdefinierten Einstellung​

Um eine benutzerdefinierte Einstellung abzurufen, verwenden Sie den folgenden Endpunkt:

GET https://dev.iclportal.com/api/settings/customusersetting/last_processed_ordernumber HTTP/1.1
Authorization: Bearer ..the auth_token...

returns 

{
  "value": {
    "ordernumber": 122
  }
}

Falls keine Einstellung vorhanden ist, gibt die API den Wert null zurück:

GET https://dev.iclportal.com/api/settings/customusersetting/this_does_not_exist HTTP/1.1
Authorization: Bearer ..the auth_token...

gibt zurück. s

{
  "value": null
}