Coupa REST API統合
このページは機械翻訳を使用して翻訳されています。
はじめに
API認証リクエストには、Coupaで生成された一意のAPIキーが必要です。
すべてのAPIリクエストは、APIキーと共にX-COUPA-API-KEY
ヘッダーを渡す必要があります。キーは、管理ユーザーが[ 管理]タブの[APIキー ]セクションから作成できます。キーは40文字の英数字コード(大文字と小文字を区別)です。APIキーは、Coupaの管理ユーザーに相当するAPIユーザーに関連付けられています。APIを介したリソースの変更はすべてAPIユーザーに帰属します。
キーに加えて、すべてのAPI要求も合格しなければならない ACCEPT
に値が設定されたヘッダを application/xml。
Coupa APIを使用して、高度なクエリを実行し、必要なデータをすばやく特定して取得できます。
詳細については、クエリオプション を参照してください。
Coupa APIを使用すると、特定の演算子や引数を使用できます。たとえば、名前(プレフィックス、サフィックスなど)または作成日に基づいてGETサプライヤーを取得できます。
ベストプラクティス
- 浅いAPI形式をAPI呼び出しで使用して、API応答のペイロードを制限できます。Coupa APIは多くのデータを返します。デフォルトでは、例えば、関連付けのための完全なオブジェクトです。その結果、戻り値が大きくなり、パフォーマンスが低下する可能性があります。これは、リソースの無駄遣いは言うまでもなく、無関係なデータを必要としないお客様にとって問題となる可能性があります。顧客のニーズにより適切に対応するために、Coupaはオブジェクトのスキーマ全体ではなく、限られたXML応答を返す
return_object=limitedコマンドを追加しました。
- すべてのトランザクションが記録され、Coupaログで検索できるように、各APIコール(成功/失敗)の統合履歴レコードと統合実行オブジェクトを更新します。
インテグレーション履歴レコードとインテグレーション実行の使用の詳細については、以下のトピックを参照してください。
最後に、REST API統合の詳細については、 The Coupa APIを参照してください。