Wie kündigt man Aufträge per API an?

Übersicht:

1. Voraussetzungen
2. Aufträge per API ankündigen

1. Voraussetzungen

1. Lesen Sie unsere detaillierte API-Dokumentation: https://docs.urbantz.com/
2. Laden Sie die API-Plattform Ihrer Wahl herunter und installieren Sie sie. Wir empfehlen Postman.
3. Sie benötigen die folgenden Informationen:
   • Den API-Schlüssel Ihrer Plattform: Zu finden unter Administration > Plattform > Allgemein
     
     
   • Den geheimen API-Schlüssel Ihres Ablaufs. Zu finden unter Administration > Abläufe > Integration > Ankündigung, dann auf die Plus-Schaltfläche klicken.

2. Aufträge per API ankündigen

1. Öffnen Sie Postman oder eine andere API-Umgebung und wählen Sie die Methode POST
2. Geben Sie diese URL ein: https://api.urbantz.com/v2/task/
3. Geben Sie die folgenden Header ein:
   • Content-type: application/json
   • x-api-key: [API-Schlüssel der Plattform]
   • x-api-secret: [API-Schlüssel des Ablaufs]
     Alternativ können Sie Basic Auth verwenden und die Anmeldedaten eingeben.
4. Fügen Sie Ihren Anfrage-Payload in den Body ein
5. Klicken Sie auf SEND

Urbantz gibt einen Statuscode, einen Zeitstempel und eine Ankündigungs-ID zurück, und auf der Ankündigungsseite Ihrer Plattform wird eine Ankündigungszeile erstellt.

Hinweis: Beachten Sie, dass das Feld 'contact.name' im API-Body der Spalte 'Kundenunternehmen' in der Auftragsansicht entspricht, während der Endempfänger im Feld contact.person widergespiegelt wird.

So werden zum Beispiel für den Empfänger „John Smith", der das Unternehmen „Smith and Sons" besitzt, die Felder wie folgt befüllt:

contact.name „Smith and Sons"

contact.person: „John Smith"