APIを使い始める

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

認証

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

Coupaは、OpenID Connectを使用してAPI要求を認証することをお勧めします。

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

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

メモ

APIキーの非推奨R
          32 - OAuth2.0は、新規顧客が利用できる唯一のオプションですR
          34 -新しいAPIキーを既存の顧客に発行することはできません
R 35 - APIキーはサポートされません
          詳細

メモ

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

APIでサポートされているメソッドは何ですか?

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

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

POST (Create Data) - JSONまたはXMLペイロードを持つリソースルートへのHTTP POST要求は、新しいリソースの作成を試みます。成功した場合、リソースはCoupaで生成される新しいIDで返されます。

メモ

データの削除は、API経由のリソースではサポートされていません。ユーザーは、PUT要求を使用してリソースのサブセットを非アクティブにすることができます。

どのような場合にAPIを使用する必要がありますか?

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

XMLとJSONの違い

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

拡張マークアップ言語( XML )は、機械可読形式でドキュメントをエンコードするためのルールのセットです。XMLの設計目標は、インターネット上のシンプルさ、一般性、および使いやすさを重視しています。

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

JSONはXMLよりも冗長ではありません。なぜなら、XMLはタグの開始と終了を必要とし(または場合によっては冗長ではない自己終了タグ)、JSONは名前/値のペアを使用します。オブジェクトの場合は「{" and "}」、配列の場合は「[" and "]」、ペアを区切る場合は「,」、名前と値を区切る場合は「:」で簡潔に記述されています。

CoupaでのXMLとJSONの違い

要求/応答のサンプル- XMLとJSON

メモ

選択する方法にかかわらず、Coupa APIでは、コンテンツタイプとコンテンツアクセプトヘッダーの両方を同じタイプに設定する必要があります。混ぜ合わせないでください。

GraphQLを使用しています

GraphQLは、APIクエリ言語(つまり「QL」リファレンス)のオープンな仕様であり、必要なデータを要求する機能を提供することで、統合をこれまで以上に応答性の高いものにすることができます。GraphQLは、必要なすべてのリソースを1回または数回の呼び出しで取得することによって、呼び出しの数と関連するラウンドトリップの数を減らすこともできます。

詳細については、GraphQLの導入を参照してください。

SFTPフラットファイルはどのような場合に使用する必要がありますか?

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

追加情報

wiki.tree (page.path)

APIオペレーター

16 August 2022

Coupaは、正確なクエリを可能にするために、多くの演算子をサポートしています。

API返品形式

03 February 2022

Coupaの浅いAPI形式を使用して、クエリ中に取得するデータ量を減らします。

APIキーのセキュリティ

14 January 2022

APIキーの有効期限と管理者が指定したAPIのアクセス許可により、APIキーのセキュリティが向上しました。

カスタムフィールドの名前空間

18 April 2019

すべての新しいカスタムフィールドは、名前の競合を回避し、顧客が追加したフィールドを識別しやすくするために、カスタムフィールドの名前空間に追加されます。

引数

24 April 2017

Coupaが演算子と連携してサポートする引数の種類について説明します。

照会オプション

21 October 2016

クエリを使用して、必要なデータをすばやく特定して取得する方法をご覧ください。

特別措置とAPIメモ

21 October 2016

Coupa APIの使用方法に関する追加情報。

  • Inhalt