サプライヤーCSP招待用APIエンドポイント
サプライヤー招待APIエンドポイントを使用すると、CSP招待を一括で送信したり、招待ワークフローを自動化したりできます。
はじめに
サプライヤーレコードを作成または編集するとき、またはサプライヤーを選択した後、[サプライヤー]テーブルの[アクション]列またはテーブルの下の[招待]ボタンからサプライヤーをCSPに招待できます。サプライヤーレコードから単一のサプライヤーを招待するか、サプライヤーページから複数のサプライヤーを招待する方法の詳細については、Coupaのオンボーディングポータルサプライヤーを参照してください。
または、APIエンドポイント(/ api/supplier_
invites)を使用してサプライヤー
のCoupa Supplier Portal (CSP)への招待を自動化し、複数のサプライヤーを1回のAPIコールで招待できます。
ワクチンの仕組み
/api/supplier_
invitesでAPIを使用して送信された招待は、UIを使用して送信された招待と同じように
動作し、同じサプライヤーの連絡先メールアドレスを使用します。1回のAPI呼び出しで最大500のサプライヤーに招待状を送信できます。
CSPアカウントを持たないサプライヤーは招待メールを受け取り、CoupaでのCSPステータスは「招待済み」に更新されます。招待を承認してアカウントを作成すると、ステータスが[リンク済み]に変わります。すでにCSPアカウントを持っているサプライヤーは、新しい顧客にリンクされていることを通知され、Coupaでのステータスがすぐにリンクされました。
招待リクエストを投稿すると、Coupaはバックグラウンドジョブを実行してサプライヤーを繰り返し、招待の対象となるサプライヤーに電子メールを送信します。サプライヤーがCSP招待の対象となるための条件はいくつかあります。
- サプライヤーのステータスを無効または下書きにすることはできません。
- サプライヤーレコードの[サプライヤー連絡先]に、[名]、[ 姓]、および[メールアドレス]フィールドを入力する必要があります。
API要素
APIはXMLとJSONの両方を受け入れ、API呼び出しで以下の情報を指定することができます。
要素 | 説明 | タイプ | 必須 | メモ |
---|---|---|---|---|
iD | システムによって割り当てられたサプライヤーのCoupaの一意の識別子。 | 整数 | はい | |
email - body | メールテキストの本文。エスケープ文字を使用して、電子メール本文にHTML要素を含めます。 | テキスト | いいえ | 以下のメールアドレスに追加情報が追加されました。 |
can_manage_contact_info | サプライヤーレコードのすべての可能なセクションの[サプライヤーによって設定]チェックボックスを選択し、Coupaで独自のレコードを更新できるようにします。 | boolean | いいえ | デフォルトはTRUEです。 |
サプライヤー招待メールの形式
Coupaが送信するメールは、API呼び出しで指定したメール本文だけではありません。これには次の部分が含まれています。
番号 | Emailエレメント | 説明 |
---|---|---|
1 | 件名 | 件名は設定できません。常に設定できます。メールアドレスを確認してください。 |
2 | Eメール本文 | API呼び出しのemail - body要素で定義されたテキスト。 |
3 | 送信者情報 | 送信者とその会社の名前。送信者のCoupaユーザーの名と 姓、および会社情報ページで指定された会社名に基づいています。 |
4 | 詳細を追加登録 | Coupaがメールに追加するボイラープレートテキストとサプライヤー固有の招待URL。 |
APIコールの例
APIは2つの基本的な機能をサポートしています。サプライヤー招待リクエストを投稿し、サプライヤーの招待のステータスを取得します。
サプライヤーをCSPに招待する
認証されたAPIコールを送信して、APIを使用してサプライヤーをCSPに招待
投稿https :// {your_instance }.coupahost.com/api/supplier_invites/
ペイロード
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<suppliers>
<supplier><id>1</id></supplier>
<supplier><id>2</id></supplier>
</suppliers>
ここに<email-body>メッセージを送ります</email-body>
<can_manage_contact_info>true</can_manage_contact_info>
</supplier-invite>
200正常応答
<?xml version="1.0" encoding="UTF-8"?>
<supplier-invite>
<id type="integer">179558</id>
<status>submitted_to_resque</status>
</supplier-invite>
422処理できないエンティティ
<errors>
指定されたサプライヤー間<error>に有効なサプライヤーがありません</error>
</errors>
一括招待アクションが成功しなかった場合、エラーのxmlまたは生成されたバックグラウンドジョブの
xmlが返されます
。これは後でバックグラウンドジョブの状態を確認するために使用できます。
招待されたサプライヤーのステータスを確認
サプライヤーのCSP招待状のステータスを確認するには、次の電話番号に連絡してください。Https ://{ your_instance }.coupahost.com/api/suppler_invites/: id
を取得
200正常応答
<supplier-invite>
<id>157</id>
<status>done</status>
</supplier-invite>