認証
すべてのデータはビジネスオブジェクトまたはリソースとして保存され、各リソースにはウェブページと同様にリソース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応答の場合は
ヘッダー、APIキー、および
」application/jsonに値が設定されたX - COUPA - API -
KEYACCEPTヘッダーを
渡す必要があります。管理者ユーザーは、[設定]タブの[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)
Coupaは、正確なクエリを可能にするために、多くの演算子をサポートしています。
Coupaの浅いAPI形式を使用して、クエリ中に取得するデータ量を減らします。
APIキーの有効期限と管理者が指定したAPIのアクセス許可により、APIキーのセキュリティが向上しました。
すべての新しいカスタムフィールドは、名前の競合を回避し、顧客が追加したフィールドを識別しやすくするために、カスタムフィールドの名前空間に追加されます。
Coupaが演算子と連携してサポートする引数の種類について説明します。
クエリを使用して、必要なデータをすばやく特定して取得する方法をご覧ください。
Coupa APIの使用方法に関する追加情報。
- 目次
-
Coupa Core API
- APIの開始
- OAuth 2.0およびOIDCへの移行
- Orchestration Documents
-
リソース
-
参照データリソース
- アカウントAPI (/accounts)
- アカウントタイプAPI (/account_types)
- 勘定科目検証ルールAPI (/account_validation_rules)
- 住所API (/addresses)
- 告知API (/announcements)
- 予算品目API(/budget lines)
- ビジネスエンティティAPI (/business_entities)
- コンテンツグループAPI (/business_groups)
- 通貨API (/currencies)
- データファイルソースAPI (/data_file_sources)
- 部署API(/departments)
- 為替レートAPI (/exchange_rates)
- 金融取引先API (/financial_counterparties)
- アイテムAPI (/items)
- 法的文書API (/legal_documents)
- 検索値API (/lookup_values)
- 照合割当API (/matching_allocations)
- 支払条件API (/payment_terms)
- プロジェクトAPI (/projects)
- レートカードAPI
- 支払先住所API(/suppliers/addresses)
- 配送条件API(/shipping_terms)
- サプライヤーAPI(/suppliers)
- サプライヤー情報API (/supplier_information)
- サプライヤー情報サイトAPI(/supplier_information_sites)
- サプライヤー情報税務登録情報API(/supplier_information_tax_registrations)
- タスクAPI (/tasks)
- 税務登録情報API(/tax_registrations)
- ユーザーAPI(/users)
-
共有リソース
- アカウントグループAPI
- 代替API
- 金額コンポーネントAPI
- 資産タグAPI
- 添付ファイルAPI
- 添付ファイルAPI
- 総括価格API
- コメントAPI
- 商品API
- サイクルカウント品目ロットAPI
- 電子署名プロバイダーアカウントAPI
- フォームAPI
- 共同購入メンバーシップAPI
- 支払API
- 予算期間API
- 目的API
- RA CLMA契約API
- RAリスク申請API
- RAリスク申請関係API
- RAリスク申請スコアAPI
- サプライヤー注文ヘッダー変更API
- タグ付けAPI
- タグAPI
- 数量単位API
- Account Category API
- ExtraLineAttributes::OrderLineAttribute API
- Return Request Line API
- Schedule Line API
-
取引リソース
- Approvals API(/approvals)
- 事前出荷通知API (/asn)
- 料金API (/charges)
- 契約API (/contracts)
- 支払API (/coupa_pay/payments )
- Coupa Pay明細書API (/coupa_pay/statements)
- カスタムオブジェクトAPI (/custom_objects/id)
- サイクルカウント品目API(/cycle_count_lines)
- データファイルソースAPI (/data_file_sources)
- 既定の受領場所API (/default_receiving_locations)
- 既定の受領場所API (/default receiving location)
- 簡易フォーム回答API (/easy_form_responses)
-
経費API(/expense_reports)
- 監査ステータスAPI
- 経費APIコールの例
- 経費アーチファクトAPI
- 経費出席者API
- 経費出席者タイプAPI
- 経費仮払金API
- 経費カテゴリーAPI
- 経費カテゴリー翻訳API
- 経費品目API
- 経費品目割当API
- 経費明細出席者API
- 経費品目の仮払金API
- 経費明細インポート済みデータAPI
- 経費品目マイレージAPI
- 経費品目マイレージ割当API
- 経費品目の日割りAPI
- 経費明細税金API
- 経費品目バーチャルカードAPI
- 経費事前承認API
- 経費事前承認品目API
- 経費レポートAPI
- 経費レポート事前承認API
- 経費出張API
- 経費出張区分API
- 経費違反API
- 経費バーチャルカードAPI
- 科目別経費品目API
- 法人API
- インテグレーションAPI(/integrations)
- 請求書API (/invoices)
- オブジェクト翻訳API (/uoms/uom_id/translations)
- 注文リストAPI(/order_pads)
- 未払金API(/payables/)
- 選択リスト/フルフィルメント予約API(/pick lists)
- 発注書API(/purchase_orders)
- 受領書API
- 受領リクエストAPI (/receipt_requests)
- 申請書API(/requisition)
- ソーシングAPI(/quote_requests)
- サプライヤーのRisk AwareフィードAPI(/supplier_risk_aware_feed)
- Order Confirmations API (/order_header_confirmations)
-
参照データリソース
- Coupaプラットフォームで構築
- CCW Flat Files (CSV)
-
Coupa Coreフラットファイル(CSV)
-
フラットファイル(CSV)エクスポート
-
Standard CSV Exports
- アカウントタイプのエクスポート
- 事前出荷明細通知エクスポート
- 商品エクスポート
- 契約エクスポート
- Coupa Pay料金のエクスポート
- Coupa Pay支払のエクスポート
- データファイルソースのエクスポート
- 委任のエクスポート
- 簡易フォームウィジェットの回答のエクスポート
- 為替レートのエクスポート
- 経費事前承認エクスポート
- 経費レポートのエクスポート
- インテグレーションエラーのエクスポート
- インテグレーション履歴記録のエクスポート
- 在庫残高のエクスポート
- 在庫取引(受領書)エクスポート
- 請求書エクスポート
- アイテムのエクスポート
- 検索値のエクスポート
- オブジェクトの翻訳のエクスポート
- 注文ヘッダー変更のエクスポート
- 注文品目変更の配分エクスポート
- 注文品目変更のエクスポート
- 未払金::割当
- 未払金::経費
- 未払金::経費事前承認エクスポート
- 未払金の請求書エクスポート
- 購買マイルストーンのエクスポート
- プロジェクトエクスポート
- プロジェクトリンクのエクスポート
- 発注書エクスポート
- 支払先住所エクスポート
- 申請書エクスポート
- ソーシングエクスポート
- ソーシング見積申請のエクスポート
- ソーシング見積返答のエクスポート
- Coupa Pay明細書エクスポート
- サプライヤー多様性レポートの直接支出のエクスポート
- サプライヤー多様性レポートの間接支出エクスポート
- サプライヤー多様性レポートの概要エクスポート
- サプライヤー情報のエクスポート
- サプライヤー情報サイト
- サプライヤーサイト
- 税金コードのエクスポート
- 税金コード規則のエクスポート
- 税務登録情報のエクスポート
- TCS税項目エクスポート
- ユーザーグループエクスポート
- 作業確認/ヘッダー(サービス/時間シートヘッダー)エクスポート
- 作業確認/品目(サービス/時間シート品目)のエクスポート
- Order Header Confirmation Export
- Order Line Confirmation Export
- Schedule Line Export
-
Standard CSV Exports
- はじめに
-
フラットファイル(CSV)のインポート
- アカウントインポート
- アカウントタイプ(CoA)のインポート
- 勘定科目検証ルールのインポート
- 承認チェーンのインポート
- 事前出荷明細通知のインポート
- 予算品目のインポート
- 予算品目調整インポート
- ビジネスエンティティのインポート
- 商品のインポート
- 商品の翻訳インポート
- 住所のインポート
- コンテンツグループインポート
- 契約インポート
- 部署のインポート
- エンタープライズインポート
- 為替レートインポート
- 経費マイレージデータのインポート
- 経費アクション動的カテゴリー制限のインポート
- 経費カテゴリーインポート
- 経費カテゴリー税率のインポート
- 経費カテゴリの翻訳インポート
- 経費インポートカテゴリーマップのインポート
- 経費インポート取引タイプフィルターマップインポート
- 経費インポートユーザーマップのインポート
- 経費支払インポート
- 外部注文のインポート
- 外部支払
- フォーム(簡易フォーム)のインポート
- インテグレーション連絡先のインポート
- 統合インポート
- 在庫残高のロットインポート
- 請求書のインポート
- インボイス支払インポート
- アイテムインポート
- 法定支払レシートローダー
- 検索値のインポート
- オブジェクトインスタンスのインポート
- オブジェクトの翻訳のインポート
- 未払金::外部::未払金インポート
- 支払条件のインポート
- プロジェクトインポート
- 発注書変更のインポート
- 見積依頼品目のインポート
- 棚卸資産取引(受領書)のインポート
- 支払先住所のインポート
- 申請書インポート
- 出荷可能追跡手段のインポート
- サプライヤーインポート
- サプライヤーのRisk Awareフィードのインポート
- サプライヤーサイトのインポート
- 税金コードのインポート
- 税金コード規則のインポート
- 税率インポート
- 税照会インポート
- 税務登録情報のインポート
- 財務キャッシュフローファイルのインポート
- ユーザーインポート
- ユーザーグループのインポート
- 倉庫所在地のインポート
- 経費レポートのインポート
- Inventory Balance Import
- Legal Entity Import
- Order Confirmation Import
- Payables :: Allocation
- Payment Import
- Treasury Commodity Rates Import
- Treasury Credit Spreads Import
- Treasury FX Forward Rates Import
- Treasury Interest Rates Import
- Treasury Interest Volatilities Import
- Treasury MMF Balances Import
- Warehouse Import
-
フラットファイル(CSV)エクスポート
- Coupa CoreアプリケーションのIPアドレス
- 古い形式
- Risk Assess Quick Integration
- Coupa Core User Authentication (SSO)
- The CCW API
- The CSO API
- Treasury Integrations