APIの開始

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

何かお探しですか？製品 Coupa製品ドキュメンテーションインテグレーション技術文書 Coupa Core API APIの開始

認証

すべてのデータはビジネスオブジェクトまたはリソースとして保存され、各リソースにはウェブページと同様に「リソースURL」があります。各リソースはフォームにあります。Coupa APIを使用する場合/api/{resource_name}. は、を使用する代わりにを使用してURLにアクセスしてくださhttps://http:// い。各Coupa顧客には、フォームの独自のURLがありま {instance_name}.coupahost.comす。例: https://companyname.coupahost.com/api/users。

Coupaでは、OpenID Connectを使用してAPIリクエストを認証することを推奨しています。

従来、OpenID Connectのサポート前は、Coupaで生成された一意のAPIキーによって、APIリクエストが認証されていました。この方法はまだサポートされていますが、R35では完全に廃止される予定です。この認証方法を使用するすべてのAPIリクエストは、 X-COUPA-API-KEYヘッダー、APIキー、およびXML応答用またはJSON応答用 ACCEPTに、値が設定されたヘッダーを渡す必要がありま application/xmlapplication/json す。キーは、管理者ユーザーが[設定]タブの[APIキー ]セクションから作成できます。キーは大文字と小文字を区別する40文字の英数字コードで、Coupaの管理者ユーザーに相当するAPIユーザーに関連付けられています。APIを介してリソースに変更を加えると、APIユーザーに帰属します。

APIキーのセキュリティーは、有効期限の設定、キーの取り消し、キーがアクセスできるオブジェクトやメソッドの設定などを行うことができます。

メモ

APIキーの廃止
R32 - OAuth2.0は新規顧客が利用できる唯一のオプションです
R34 – 既存の顧客に新しいAPIキーを発行できなくなりました
R35 - APIキーはサポートされなくなります
詳細

メモ

Coupaのペイロード構造は将来的に値のない特定のフィールドやnull値を表示しないように変更する可能性があるため、値を取得する前に常にXML/JSONの要素の存在を検証してください。

APIではどのような方法がサポートされていますか？

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

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

POST(データの作成)- JSONまたはXMLペイロードを使用してリソースルートへのHTTP POSTリクエストは、新しいリソースの作成を試みます。成功した場合、Coupaによって生成された新しいIDでリソースが返されます。

メモ

データの削除は、APIを介したリソースではサポートされていません。ユーザーは、PUTリクエストを使用してリソースのサブセットを無効にできます。

APIはいつ使用すればよいですか？

Coupa APIを使用すると、個々のエントリーを作成、更新、クエリできます。主にCoupa内でオブジェクトを管理するために使用されます。標準のRESTfulアクションと明確な入力と出力により、非一括アクションの日常的なオプションとして簡単に使用できます。これらのメソッドはいつでもアクセスでき、組み込みのツールにより、コールが正常に実行されるかどうかを簡単に確認したり、応答の出力を最小限に抑えたりできます。これは主に、単純な個別の更新を行うか、データを問い合わせるために使用されます。

XMLとJSON

CoupaはXMLとJSONの両方をサポートしています。以下は、それぞれの基本情報です。

XML(Extensible Markup Language)は、コンピュータが読める形式で文書をエンコードするためのルールセットです。XMLの設計目標は、インターネット上のシンプルさ、汎用性、使いやすさを重視しています。

JavaScriptオブジェクト表記(JSON)は、人間が読めるデータ交換のために設計された、軽量なテキストベースのオープン標準です。これは、オブジェクトと呼ばれる単純なデータ構造と連想配列を表現するためのJavaScriptプログラミング言語から派生しています。JavaScriptとの関係にもかかわらず、言語に依存せず、ほとんどのプログラミング言語で使用できるパーサーがあります。

JSONはXMLよりも冗長ではありません。XMLでは開始タグと終了タグが必要です（場合によっては冗長でない自己終了タグ）。JSONでは名前/値のペアを使用し、オブジェクトには「{」と「}」、配列には「[」と「]」、ペアには「,」、値と名前の分離には「:」を使用します。

CoupaのXMLとJSONの違い

サンプルのリクエスト/応答 – XMLとJSON

メモ

選択した方法に関係なく、Coupa APIではcontent-typeヘッダーとcontent-acceptヘッダーの両方を同じタイプに設定する必要があります。混ざり合わないでください。

GraphQLの使用

GraphQLは、APIクエリ言語（つまり「QL」参照）のオープン仕様であり、必要なデータのみをリクエストする機能を提供することで、インテグレーションをこれまでになく応答性の高いものにできます。GraphQLでは、1回または数回の呼び出しで必要なすべてのリソースをフェッチすることで、行っている呼び出しと関連する往復の数を減らすこともできます。

詳細は、「GraphQLの概要」を参照してください。

SFTPフラットファイルはいつ使用すればよいですか？

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