API-Endpunkt für CSP-Einladungen von Lieferanten
Mit dem Einladungs-API-Endpunkt des Lieferanten können Sie Massen-CSP-Einladungen senden oder Ihren Einladungsworkflow automatisieren.
Einleitung
Sie können Lieferanten zum CSP einladen, wenn Sie einen Lieferantendatensatz erstellen oder bearbeiten, oder über die Spalte Aktionen in der Tabelle Lieferanten oder über die Schaltfläche Einladen unter der Tabelle, nachdem Sie die Lieferanten ausgewählt haben. Weitere Informationen zum Einladen eines einzelnen Lieferanten aus dem Lieferantendatensatz oder mehrerer Lieferanten von der Seite Lieferanten finden Sie unter Onboarding-Portal Lieferanten in Coupa.
Sie können auch den API-Endpunkt unter/api/supplier_invites verwenden, um Ihre Lieferanteneinladungen zum Coupa Supplier Portal (CSP) zu automatisieren und mehrere Lieferanten in einem einzigen API-Aufruf einzuladen.
So funktioniert es
Einladungen, die über die API unter/api/supplier_invites gesendet werden, verhalten sich genauso wie Einladungen, die über die Benutzeroberfläche gesendet werden, und verwenden dieselbe E-Mail-Adresse des Lieferantenkontakts. In einem einzigen API-Aufruf können Sie Einladungen an maximal 500 Lieferanten senden.
Lieferanten ohne CSP-Konto erhalten eine E-Mail-Einladung und ihr CSP-Status in Coupa wird auf Eingeladen aktualisiert. Sobald sie die Einladung annehmen und ein Konto erstellen, ändert sich ihr Status in Verknüpft. Lieferanten, die bereits ein CSP-Konto haben, werden benachrichtigt, dass sie mit einem neuen Kunden verknüpft sind, und ihr Status in Coupa wird sofort auf Verknüpft aktualisiert.
Wenn Sie eine Einladungsanfrage VERÖFFENTLICHEN, führt Coupa einen Hintergrundauftrag aus, der die Lieferanten durchläuft und E-Mails an Lieferanten sendet, die für Einladungen berechtigt sind. Es gibt einige Bedingungen, unter denen Lieferanten für eine CSP-Einladung in Frage kommen:
- Der Status des Lieferanten kann nicht Inaktiv oder Entwurf sein.
- Unter Lieferantenkontakt im Datensatz des Lieferanten müssen die Felder Vorname, Nachname und E-Mail ausgefüllt werden.
API-Elemente
Die API akzeptiert sowohl XML als auch json und ermöglicht es Ihnen, die folgenden Informationen in Ihrem API-Aufruf anzugeben:
| Element | Beschreibung | Typ | Erforderlich | Notizen |
|---|---|---|---|---|
| iD | Eindeutige Kennung von Coupa für den Lieferanten, wie vom System zugewiesen. | ganze Zahl | Ja | |
| email-body | Der Hauptteil des E-Mail-Textes. Verwenden Sie Escape-Zeichen, um HTML-Elemente in den E-Mail-Text aufzunehmen. | text | Nein | Zusätzliche Informationen, die der unten gezeigten E-Mail hinzugefügt wurden. |
| can_manage_contact_info | Aktiviert das Kontrollkästchen Nach Lieferant festlegen für alle möglichen Abschnitte im Lieferantendatensatz, damit sie ihren eigenen Datensatz in Coupa aktualisieren können. | boolean | Nein | Die Standardeinstellung ist WAHR. |
E-Mail-Format der Lieferanteneinladung
Die E-Mail, die Coupa sendet, ist mehr als nur der E-Mail-Text, den Sie im API-Aufruf angeben. Es umfasst die folgenden Teile:
| Nummer | E-Mail-Element | Beschreibung |
|---|---|---|
| 1 | Betreffzeile | Die Betreffzeile ist nicht konfigurierbar; sie ist immer Bitte bestätigen Sie Ihre E-Mail-Adresse. |
| 2 | E-Mail-Text | Der Text, der im E-Mail-Body-Element des API-Aufrufs definiert ist. |
| 3 | Informationen zum Absender | Der Name des Absenders und seines Unternehmens. Basierend auf dem Vor- und Nachnamen des Coupa-Benutzers des Absenders und dem Firmennamen, wie auf der Seite mit den Unternehmensinformationen angegeben. |
| 4 | Einladungsdetails | Textbaustein und lieferantenspezifische Einladungs-URL, die Coupa der E-Mail hinzufügt. |
Beispiel-API-Aufrufe
Die API unterstützt zwei Grundfunktionen: BUCHEN SIE die Lieferanteneinladungsanfrage und ERHALTEN SIE den Status der Einladung eines Lieferanten.
Lieferanten zum CSP einladen
Laden Sie Lieferanten über die API zum CSP ein, indem Sie einen authentifizierten API-Aufruf senden:
BEITRAG https://{your_instance}.coupahost.com/api/supplier_invites/
Nutzdaten
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<suppliers>
<supplier><id>1</id></supplier>
<supplier><id>2</id></supplier>
</suppliers>
<email-body>Nachricht hier</email-body>
<can_manage_contact_info>wahr</can_manage_contact_info>
</supplier-invite>200 Erfolgsreaktion
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<id type="integer">179558</id>
<status>submitted_to_resque</status>
</supplier-invite>422 Nicht verarbeitbare Einheit
<errors>
<error>Es gibt keine gültigen Lieferanten unter den angegebenen</error>
</errors>Wenn die Masseneinladungsaktion nicht erfolgreich ist, gibt sie ein xml eines Fehlers oder das xml eines generierten Hintergrundjobs zurück, das Sie später verwenden können, um den Status Ihres Hintergrundjobs anzuzeigen.
Status eines eingeladenen Lieferanten prüfen
Überprüfen Sie den Status der CSP-Einladung eines Lieferanten, indem Sie Folgendes anrufen:
GET https://{your_instance}.coupahost.com/api/suppler_invites/:id GET
200 Erfolgsantwort
<supplier-invite>
<id>157</id>
<status>fertig</status>
</supplier-invite>