Dieser Artikel beschreibt die Schritte zum Generieren und Herunterladen von Arbeitsaufträgen mit der Scantrust-API. Das UAT-Token benötigt Zugriff auf die folgenden Berechtigungen:
- scans_download
Wichtig:
Um Zugriff auf die Scantrust REST API zu erhalten, können Sie eine API-Plattform wie Postman verwenden. Postman ist die weltweit beliebteste API-Plattform mit über 17 Millionen Nutzern und 500.000 Organisationen weltweit. Das Tool bietet eine flexible und kollaborative Umgebung, mit der Sie Ihre APIs schneller entwerfen, entwickeln, dokumentieren und testen können.
Sie können die Webanwendung ausprobieren oder diese App über diesen Link herunterladen und installieren: https://www.postman.com/downloads/ In jedem Fall ist die Anmeldung mit einer gültigen E-Mail-Adresse erforderlich.
Hinweis: Im Scantrust-Kontext sollte Postman nur zu Testzwecken verwendet werden. Es ist nicht für den Einsatz in realen Szenarien oder Projektimplementierungen vorgesehen.
Schritte zum Konfigurieren von Postman
1. Öffnen Sie Postman. Auf der Startseite sollten Sie Folgendes sehen:
2. Klicken Sie dann oben links auf die Registerkarte „Arbeitsbereiche“:
3. Klicken Sie dann auf die Option „Mein Arbeitsbereich“:
4. Sobald Sie in Ihrem Arbeitsbereich sind, klicken Sie bitte wie folgt auf das „+“-Zeichen:
5. Danach erscheint eine neue Registerkarte mit einer vorkonfigurierten API-Anfrage: GET:
6. Nun ist es wichtig, die API-Autorisierung einzurichten. Klicken Sie dazu auf den Reiter „Autorisierung“:
7. Klicken Sie dann auf den Abschnitt „Typ“ und wählen Sie die Option „API-Schlüssel“ wie folgt aus:
8. Geben Sie nun das Wort „Authorization“ in das Schlüsselfeld ein, kopieren Sie dann Ihr UAT-Token aus dem ST-Portal und fügen Sie es in das Feld mit der Bezeichnung „Value“ ein, einschließlich der Zeichen UAT:UAT [Ihr Token],Lassen Sie zwischen der UAT-Zeichenfolge und dem Token eine Leertaste:
9. Gehen Sie dann zur Registerkarte „Body“, wählen Sie „raw“ und dann „JSON“ aus:
Schritte zum Herunterladen der Scandaten
Um Ihre Scandaten herunterzuladen, müssen Sie:
- Suchen Sie die Kampagnen-ID
- Legen Sie den Zeitrahmen fest, um die Scans basierend auf einem Zeitbereich zu filtern.
So finden Sie Ihre Kampagnen-ID:
1. Melden Sie sich im Portal an und klicken Sie im linken Hamburger-Menü auf KAMPAGNEN.
2. Klicken Sie bei der Kampagne, für die Sie die Daten herunterladen möchten, auf das DASHBOARD-Symbol:
3. Wenn das Dashboard geöffnet wird, wird die URL im Browser angezeigt:
https://portal.scantrust.com/#/dashboard?tabIndex=0&Kampagnen-ID=126&Seite=1
Die Kampagnen-ID ist fett gedruckt.
4. Anschließend müssen Sie die Informationen filtern, die Sie herunterladen möchten. Alle im Dashboard verwendeten Filter können auch zum Filtern der heruntergeladenen Scans verwendet werden. Sie möchten beispielsweise alle Scans filtern und herunterladen für Kampagne 195,die markiert wurden außerhalb des Marktes und die haben beabsichtigter_Markt auf "China" eingestellt (Zh). Um dies zu erreichen, müssen Sie eine GET-Anfrage mit der folgenden URL stellen:
5. Anschließend sollten Sie die Antwort 200 OK erhalten:
Kommentare