APIを開始する

Coupa APIの使用に関する一般情報と、CSVの使用を検討するタイミング。

ベースURL

すべてのデータはビジネスオブジェクトまたは リソースとして格納され、 各リソースにはWebページと同様に リソースURLがあり、各リソースは /api/{resource_name}.の形式になります。 Coupa APIを使用する場合は、 http :// ではなく https :// を使用してURLにアクセスしてください。 Coupaの各顧客には、 {instance_name}.coupahost.comという形式の独自のURLがあります 例： https://companyname.coupahost.com/api/users

認証

Coupa APIは、OpenID Connect (OIDC)を使用してOAuth 2.0を使用したリクエストを認証します。 詳細はOpenID Connectをご参照ください。

サポートされているAPIメソッド

GET (データの読み取り) - HTTP GETリクエストはCoupaにクエリを実行し、JSONまたはXML形式で情報を返します。 リソースルートでのリクエストは、ID 1から始まる最初の50個のオブジェクトを一覧表示します。 これらの引数を使用してクエリを微調整してください。

PUT （データの更新） - /api/{resource}/{id} へのHTTP PUT要求は、リソースの更新を試みます。 リクエストごとに更新できるリソースは1つのみで、ペイロードは更新する要素を含むJSONまたはXMLドキュメントである必要があります。 すべてのフィールドがAPIを介して利用できるわけではなく、参照データがすでに存在している必要があります。そうでない場合、値は変更されません。

POST (データの作成) - JSONまたはXMLペイロードを持つリソースルートへのHTTP POSTリクエストが新しいリソースの作成を試みます。 成功すると、リソースはCoupaで生成される新しいIDで返されます。

注:

API経由では、どのリソースでもデータの削除はサポート対象ではありません。 PUTリクエストを使用すると、リソースのサブセットを非アクティブ化することができます。

XMLとJSON

Coupaは、XMLとJSONの両方をサポートしています。 詳細は次のリソースをご参照ください。

注:

いずれの方法でも、Coupa APIではcontent-typeヘッダーとcontent-acceptヘッダーの両方を同じタイプに設定する必要があります。

GraphQL

GraphQLは、APIクエリ言語(「QL」リファレンス)のオープン仕様であり、必要なデータのみをリクエストする機能を提供し、連携の応答性をこれまで以上に高めます。 GraphQLは1回または少数の呼び出しで必要なすべてのリソースを取得するため、呼び出しの数と往復を減らすこともできます。

詳細はGraphQLの導入をご参照ください。

CSVフラットファイル

フラットファイルを使用すると、1件の取引で多くのレコードを読み込むことができます。 連携の設定後、設定されたパラメータに基づいて自動的に実行されます。 連携の実行とエラーはアプリ内で管理され、追加されたエントリの数、エラーの詳細、エラーについて自動的に連絡されたユーザーに関するインサイトを提供します。 CSVを使用すると、ユーザーやサプライヤーなど、製品の主要コンポーネントに関する一括更新や追加を行うことができます。

その他のリソース

詳細は次のリソースをご参照ください。