Point d'extrémité d'API pour les invitations de fournisseur CSP
Le point de terminaison API des invitations des fournisseurs vous permet d'envoyer des invitations CSP groupées ou d'automatiser votre flux de travail d'invitation.
Introduction
Vous pouvez inviter des fournisseurs au CSP lorsque vous créez ou modifiez un enregistrement de fournisseur, ou à partir de la colonne Actions dans le tableau Fournisseurs ou du bouton Inviter sous le tableau après avoir sélectionné le ou les fournisseurs. Pour plus d'informations sur l'invitation d'un seul fournisseur à partir du dossier du fournisseur ou de plusieurs fournisseurs à partir de la page Fournisseurs, voir Intégration des fournisseurs du portail dans Coupa.
Vous pouvez également utiliser le point de terminaison de l'API à l'adresse/api/supplier_invites pour automatiser vos invitations de fournisseurs sur le Coupa Supplier Portal (CSP) et inviter plusieurs fournisseurs en un seul appel d'API.
Comment ça marche
Les invitations envoyées à l'aide de l'API à/api/supplier_invites se comportent comme les invitations envoyées à l'aide de l'interface utilisateur et utilisent la même adresse e-mail de contact fournisseur. Vous pouvez envoyer des invitations à un maximum de 500 fournisseurs en un seul appel API.
Les fournisseurs sans compte CSP reçoivent une invitation par e-mail et leur statut CSP dans Coupa est mis à jour en Invité. Une fois qu'ils ont accepté l'invitation et créé un compte, leur statut passe à Lié. Les fournisseurs qui ont déjà un compte CSP sont informés qu'ils sont liés à un nouveau client et que leur statut dans Coupa est immédiatement mis à jour en Linked.
Lorsque vous PUBLIEZ une demande d'invitation, Coupa exécute une tâche en arrière-plan qui parcourt les fournisseurs et envoie des e-mails aux fournisseurs éligibles aux invitations. Il y a quelques conditions pour que les fournisseurs soient éligibles à une invitation CSP :
- Le statut du fournisseur ne peut pas être Inactif ou Brouillon.
- Sous Contact fournisseur dans le dossier du fournisseur, les champs Prénom, Nom et E-mail doivent être remplis.
Éléments API
L'API accepte à la fois XML et JSON, et vous permet de spécifier les informations suivantes dans votre appel API :
| Élément | Description | Type | Obligatoire | Remarques |
|---|---|---|---|---|
| id | Identifiant unique de Coupa pour le fournisseur, tel qu'attribué par le système. | nombre entier | Oui | |
| corps de l'e-mail | Le corps principal du texte du courriel. Utilisez des caractères d'échappement pour inclure des éléments HTML dans le corps de l'e-mail. | texte | Non | Informations supplémentaires ajoutées à l'e-mail ci-dessous. |
| can_manage_contact_info | Coche la case Définir par fournisseur pour toutes les sections possibles du dossier du fournisseur, ce qui leur permet de mettre à jour leur propre dossier dans Coupa. | boolean | Non | La valeur par défaut est TRUE. |
Format e-mail d'invitation fournisseur
L'e-mail que Coupa envoie est plus que le corps de l'e-mail que vous spécifiez dans l'appel API. Il comprend les parties suivantes :
| Nombre | Élément Email | Description |
|---|---|---|
| 1 | Objet | La ligne d'objet n'est pas configurable ; elle l'est toujours. Veuillez confirmer votre e-mail. |
| 2 | Corps de l'e-mail | Le texte qui est défini dans l'élément email-body de l'appel API. |
| 3 | Informations sur l'expéditeur | Le nom de l'expéditeur et de son entreprise. Sur la base du prénom et du nom de famille de l'utilisateur Coupa de l'expéditeur, et du nom de la société tel que spécifié sur la page d'informations sur la société. |
| 4 | Détails de l'invitation | Texte type et URL d'invitation spécifique au fournisseur que Coupa ajoute à l'e-mail. |
Exemples d'appels d'API
L'API prend en charge deux fonctions de base : PUBLIEZ la demande d'invitation d'un fournisseur et OBTENEZ le statut de l'invitation d'un fournisseur.
Inviter un fournisseur au CSP
Inviter des fournisseurs au CSP en utilisant l'API en envoyant un appel d'API authentifié :
PUBLIER https ://{your_instance}.coupahost.com/api/supplier_invites/
Charge utile
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<suppliers>
<supplier><id>1</id></supplier>
<supplier><id>2</id></supplier>
</suppliers>
<email-body>Envoyer un message ici</email-body>
<can_manage_contact_info>true</can_manage_contact_info>
</supplier-invite>200 Réponse positive
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<id type="integer">179558</id>
<status>submitted_to_resque</status>
</supplier-invite>422 Entité non traitable
<errors>
<error>Il n'y a pas de fournisseurs valides parmi ceux spécifiés</error>
</errors>Si l'action d'invitation groupée échoue, elle renvoie un xml d'une erreur ou le xml d'une tâche en arrière-plan générée, que vous pouvez utiliser plus tard pour voir l'état de votre tâche en arrière-plan.
Vérifier le statut d'un fournisseur invité
Vérifier le statut de l'invitation CSP d'un fournisseur en appelant :
GET https ://{votre_instance}.coupahost.com/api/suppler_invites/ :id GET
200 Réussite réponse
<supplier-invite>
<id>157</id>
<status>terminé</status>
</supplier-invite>