Anfang #

Um mit der REST API zu beginnen, führen Sie jeden der folgenden Schritte in der Reihenfolge durch:

1. Abfrage API Zugriff #

Die REST API ist standardmäßig deaktiviert. Sie kann von jedem Benutzer aktiviert werden, dem die Rolle 'REST API Administrator' zugewiesen wurde.

Sobald die Optionen "Onboarding Control aktivieren" aktiviert wurden, folgen Sie den folgenden Schritten:

• Notieren Sie sich die Client-ID und das Kundengeheimnis
• Geben Sie das Redirect-Uri¹ ein, das das REST API verwendet, um Ihre Anwendung zurückzurufen
• Drücken Sie den Button 'Onboarding-Client erstellen'

2. Tokens authentifizieren und generieren #

Um das API zu verwenden, muss der Authentifizierungsprozess befolgt werden, um eine Verbindung zu Ihrem ~.Dimensions.~ Portal. Dies führt dazu, dass Access- und Refresh-Token generiert werden.

Folgen Sie dem untenstehenden Link, um den Authentifizierungsprozess zu starten:

• Authentifizierungsprozess

info
Ein gültiger Nutzer auf deiner ~.Dimensions.~ Portal ist erforderlich, um diesen Prozess abzuschließen.

tip

Um schnell zum Laufen zu kommen, haben wir eine Postman-Sammlung und Umgebung bereitgestellt, die verwendet werden kann, um API-Aufrufe vor und während der Entwicklung zu testen und zu verifizieren.

~.Dimensions.~ Postman-Sammlung/Umgebung

3. Kontoverwaltung mit der API #

Sobald Sie die erforderlichen Token haben, können Sie beginnen, API Anfragen zu erstellen. Die untenstehenden Links geben Informationen zum vollständigen API.

• Volles API Referenz