APIの使用
概要
Coupaは、RESTful APIにより、データの読み取り、編集、統合を行うための豊富で堅牢なアクセスを提供します。このUTF -8 XMLベースのインターフェイスにより、HTTPSリクエストコールを実行して、Coupa内で個々のレコードの作成、更新、操作ができます。
Coupaリリース15の新機能
APIキーは、APIアクセスと管理へのアクセス許可を提供するように構成できます。これにより、管理者は1つのAPIキーからすべてのCoupa APIへのアクセスと使用を制限できます。キーには有効期限を設定することもできます。管理者が有効期限を指定しない場合、キーは有効期限切れになりません。有効期限が指定されている場合、APIキーはその日の終わり（ UTC午前0時）に期限切れになります。
Coupa REST APIの使用方法
Coupaでは、すべてのデータがビジネスオブジェクトまたはリソースとして保存され、各リソースにはウェブページと同様にリソースURLが割り当てられます。各Coupa顧客には、{customer_name }.coupahost.comという独自のURLがあります。各リソースは、/api /[ resource]の形式です。Coupa APIを使用する場合は、httpではなくhttpsを使用してURLにアクセスしてください。
たとえば、請求書APIのURLは次のようになります。
https :// {インスタンス名}.coupahost.com/api/invoices
Coupa API呼び出しを行うには、呼び出し元プログラムに安全なAPIキーが必要です。キーを生成して提供するには、Coupa管理者または統合アーキテクトにお問い合わせください。APIキーを安全に保ち、許可されていないユーザーと共有しないでください。
すべてのAPI要求は、次のヘッダーを渡す必要があります:
Coupa APIキーを使用したX - COUPA - APIキー- 値を
application/xmlに設定したヘッダーを受け入れます。
Coupa APIでは、名前(接頭辞、接尾辞など)や作成日などに基づいてサプライヤーを取得するなど、特定の演算子や引数を使用できます。詳細については、APIの使用を開始するを参照してください
ベストプラクティス
浅いAPI形式は、API呼び出しに使用して、API応答のペイロードを制限することができます。CoupaのAPIは、デフォルトで多くのデータを返します（例えば、関連付けのための完全なオブジェクト）。これにより、大きなリターン値が生じる可能性があり、これらのリターンはパフォーマンスの低下を引き起こす可能性があります。これは、リソースの不必要な消費は言うまでもなく、無関係なデータを必要としない顧客にとっては問題になる可能性があります。顧客のニーズをよりよく満たすために、Coupaはコマンドreturn_object = limitedを追加しました。これは、オブジェクトのスキーマ全体ではなく、制限されたxml応答を返します。
エラー処理/メッセージ
CXMLの場合、成功した要求はHTTP 200 OKを返します。応答の本文には、オブジェクトの詳細が含まれます。失敗した要求は、HTTPシリーズ4 xxまたは5 xx Bad Requestを返します。応答の本文には、XML形式の検証エラーが含まれます。呼び出しプログラムには、応答メッセージを読み取り、それに応じて是正措置を講じるためのエラー処理ロジックが必要です。
CoupaがcXML請求書ファイルを受け取ると、請求書がCoupaにアップロードされる前に次の検証手順が実行されます。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。