APIの使用
このページは機械翻訳を使用して翻訳されています。
概要
Coupaは、RESTful APIを介してデータを読み取り、編集、または統合するための豊富で強力なアクセスを提供します。このUTF-8 XMLベースのインターフェースを使用すると、HTTPSリクエストを呼び出すことで、Coupa内の個々のレコードを作成、更新、および操作できます。
Coupaリリース15の新機能
APIキーは、APIアクセスと管理に権限を与えるように設定できます。これにより、管理者は単一のAPIキーからすべてのCoupa APIへのアクセスと使用を制限することができます。キーには有効期限を設定することもできます。管理者が有効期限を指定しない場合、キーは無期限になります。有効期限が指定されている場合、APIキーは1日の終わり（UTCの午前0時）に期限切れになります。
Coupa REST APIの使用方法
Coupaでは、すべてのデータはビジネスオブジェクトまたはリソースとして保存され、各リソースにはウェブページのようにリソースURLがあります。{customer_name}.coupahost.comCoupaの顧客はそれぞれ、という形式の独自のURLを持っています。各リソースは /api/[resource]の形式です。Coupa APIを使用する場合は、httpではなくhttpsを使用してURLにアクセスしてください。
たとえば、請求書APIのURLは次のようになります。
https://{instance name}.coupahost.com/api/invoices
Coupa API呼び出しを行うには、呼び出し元プログラムに安全なAPIキーが必要になることに注意してください。Coupa管理者またはインテグレーションアーキテクトに連絡して、キーの生成と提供を依頼してください。APIキーを安全に保ち、不正なユーザーと共有しないでください。
すべてのAPIリクエストは以下のヘッダーを渡す必要があります：
X-COUPA-API-KEYCoupa APIキー付き値が[]に</a>設定された<a id="x6" xid="i19.1.1">ヘッダー。ACCEPTapplication/xml
Coupa APIでは、名前（接頭辞、接尾辞など）や作成日などに基づくGETサプライヤーのような特定の演算子や引数を使用できます。参照してください [1] 詳細はAPIの入門
ベストプラクティス
浅いAPI形式をAPI呼び出しで使用して、API応答のペイロードを制限できます。CoupaのAPIは、デフォルトで多くのデータを返します（例：関連オブジェクトとしての全オブジェクト）。その結果、戻り値が非常に大きくなり、これらの戻り値によってパフォーマンスが低下する可能性があります。これは、リソースの不要な消費はもちろんのこと、無関係なデータを必要としない顧客にとっては問題となる可能性があります。顧客のニーズにより適切に対応するために、Coupaは、スキーマ全体ではなく制限されたXML応答を返すコマンドreturn_object = limitedを追加しました。オブジェクト。
エラー処理/メッセージ
cXMLの場合、成功したリクエストはHTTP 200 OKを返します。応答の本文にはオブジェクトの詳細が含まれます。失敗したリクエストは、HTTPシリーズ4xxまたは5xx不良リクエストを返します。応答の本文には、XML形式の検証エラーが含まれます。呼び出しプログラムには、応答メッセージを読み、それに応じて修正アクションを実行するエラー処理ロジックが必要です。
CoupaがcXMLインボイスファイルを受け取ると、インボイスがCoupaにアップロードされる前に、次の検証手順が実行されます。