Download OpenAPI (fka Swagger) specification:here
Zuora REST APIのリファレンスへようこそ！
RESTは、HTTPとJSON技術の日常を使用して迅速な開発に向いているウェブ・サービス・プロトコルです。
Zuora REST APIは、業務とリソースの広範なセットを提供します：
Zuora REST APIは、以下のエンドポイントを介して提供されます。
テナントRESTエンドポイントのベースURL
生産https://rest.zuora.com/v1
APIサンドボックスhttps://rest.apisandbox.zuora.com/v1
生産エンドポイントユーザデータは、ライブへのアクセスを提供します。 APIのサンドボックスのテナントは、実世界のデータに影響を与えることなく、あなたのコードをテストするには良い場所です。それを使用するには、APIのサンドボックスのテナントをプロビジョニングする必要があります - 必要に応じてあなたのZuoraの担当者があなたを助けることができます。
あなたはテナントZuoraをお持ちの場合は、すでにAPIへのアクセス権を持っています。
あなたはテナントZuoraを持っていない場合は、https://www.zuora.com/resource/zuora-test-driveに移動し、生産テストドライブのテナントにサインアップします。テナントは、このような試料の製品カタログなどのシード・データ、付属しています。
私たちはあなたのAPIがAPIのユーザにコールを発信するために特別に作成することをお勧めします。このアカウントでZuora UIにログインしないでください。定期的にセキュリティ機能を有効にUIにログインすると、最終的にはAPIで失敗認証が発生する可能性があり、アカウントのパスワードを、有効期限が切れます。それはそれらの命令に記載されているように権限を持っていない限り、ユーザーの役割がZuora REST APIの書き込みアクセスサービスへの書き込みアクセス権を持っていないことに注意してください。
認証する3つの方法があります。
ユーザー名とパスワードを使用してください。認証ヘッダー内の各リクエストに含めます：
認可クッキーを使用してください。クッキーは、[管理]> [セキュリティポリシー]> [セッションタイムアウトで指定された期間のためのREST APIへの呼び出しを行うようにユーザーに許可します。クッキーの有効期限は、REST APIにこの期間を持つすべての呼び出し後にリセットされます。クッキーを取得するには、次の情報をREST API接続リソースのユーザーを呼び出します。
パラメータは実体識別子とエンティティ名Zuoraマルチエンティティのために使用されています。
実体識別子とエンティティ名のパラメータは、IDとあなたがそれぞれ、アクセスしたいエンティティの名前を指定します。あなたは、エンティティへのアクセス権限を持たなければならないことに注意してください。あなたは、RESTのGET呼び出しを介してエンティティIDのエンティティとエンティティ名を取得することができます。
あなたがアクセスしたエンティティに表示するエンティティ名実体または認証のパラメータを指定することができます。
詳細については、APIユーザー認証を参照してください。
CORS機構はZuora REST APIに可能Zuoraに直接送信された全てのクレジットカード情報とセキュリティ情報と、顧客のブラウザから直接作られて呼び出します。これは、あなたのPCIコンプライアンスの負担を最小限に抑え、あなたの支払フォーム上に実装高度な検証を可能にし、お支払いフォームがちょうどあなたのウェブサイトの他の部分のように見えます。
セキュリティ上の理由から、代わりにCORSのためのAPI要求を経由して、クッキーを使用するのは、認証トークンを使用します。
認証トークンの方法は、あなたの顧客のブラウザから発信する必要があり要求で使用するために設計されています。それは、既存のクッキー認証機構への交換と考えるべきではありません。
Zuora REST CORS CORSがどのように動作するかの詳細については、を参照してください、あなたはZuora REST APIに実装され、顧客のコールを開始することができますか。認証トークンを返すHMAC方式でのHMAC署名の詳細を参照してください。
アカウントまたはサブスクリプション（accountKey、アカウントキー、subscriptionKey、サブスクリプション・キー）のための「キー」を入力するように要求一般的なルールとして、あなたは、現在のいずれかまたはエンティティのID番号を提供することができます。
あなたのリクエストに付随するパラメータやデータの大部分は、HTTPリクエストのボディに含まれることになります。
Zuora REST APIは、HTTP要求本体にJSONを受け入れます。その他のデータ形式（例えば、XML）がサポートされていません。
Zuora REST APIをテストするために、このようなカール、ポストマン、またはAdvanced RESTクライアントとして、サードパーティのクライアントを使用してください。
あなたはZuoraテナントからZuora REST APIのAPIのサンドボックスまたは生産をテストすることができます。生産に接続する場合は、あなたが生きて製造年月日、サンプルまたはテストデータのない日付で作業していることに注意してください。
遅かれ早かれ、おそらくクレジットカードを必要とする一部のトランザクションをテストする必要があります。これを処理する際の方法については、ペイメントゲートウェイでライブ行く参照してください。
レスポンスおよびエラー・コードは、応答とエラーに詳述されています。
（GETメソッドを使用して）情報を取得する場合、任意のページサイズのクエリパラメータは、行の最大数が応答で返すように設定します。最大値は40です。この値が空または無効である場合は、より大きな値を40として処理され、10に一般的にデフォルト値をPAGESIZE。
最大行数のデフォルト値は、メソッドレベルで取得上書きすることができます。
複数の行が使用可能な場合、応答は次のページを要求するためのURLが含まれているボニー要素が含まれます。この値が提供されていない場合、それ以上の行が用意されています。いいえ、「前のページ」の要素が明示的に提供されていません。後方支援するためのページングは、前回のコールを使用しています。
日付をページ分割されていない項目については、REST APIは、最大300行の配列をサポートしています。したがって、例えば、顧客口座数千人を取得繰り返さページ付けすることができますが、300以下の料金プランの配列内の任意のアカウントが返されます。
Zuora REST APIは、バージョンを制御しています。 Zuora REST APIのバージョンは、変更は下位互換性があることを保証します。メジャーとマイナーバージョンの変更の命名を管理するためにZuoraを使用します。 RESTリクエストでバージョンを指定することで、あなたは関係なく、APIの将来の変更の自然な応答を得ることができます。
REST APIのメジャーバージョン番号は、REST URLに表示されます。現在、Zuoraメジャーバージョンのみv1のをサポートしています。たとえば、POSTがhttps://rest.zuora.com/v1/subscriptions。
小さな変化を制御するためのREST APIのZuoraマイナーバージョンを使用しています。例えば、REST方式のフィールドは廃止され、新しいフィールドがそれを置き換えるために使用されます。
RESTの方法のいくつかのフィールドは、マイナーバージョンでサポートされています。フィールドがマイナーバージョンで注目されていない場合、このフィールドは、マイナーすべてのバージョンで利用可能です。フィールドがマイナーバージョンで注目されている場合、このバージョンは、制御フィールドです。あなたはエラーなしプロセスにリクエストヘッダにサポートされているマイナーバージョンを指定する必要があります。
フィールドは、バージョン管理にある場合は、最大値またはマイナーバージョン最小マイナーバージョンと、またはそれらの両方のいずれかです。あなただけの最小値と最大値のマイナーバージョン間のマイナーで、このフィールドのバージョンを使用することができます。たとえば、フィールドにinvoiceCollect購読POSTメソッドは、バージョン管理であり、その最大値は189.0マイナーバージョンです。あなただけのマイナーバージョン189.0またはそれ以前に、このフィールドを使用することができます。
サポートされているマイナーバージョンはサポートされているフィールドとそのマイナーバージョンについてはZuora REST APIのマイナーバージョン履歴を参照して、シリアルではありません。フィールドまたは機能は、マイナーバージョン番号が必要な場合、当社のREST APIドキュメントでは、我々は、説明フィールドにあることに注意します。
あなただけがフィールドは、マイナーバージョンが必要です使用する場合、バージョン番号を指定する必要があります。マイナーバージョンを指定するには、通話要求のためのマイナーバージョン番号にリクエストヘッダにzuoraバージョンのパラメータを設定します。例えば、196.0はマイナーバージョン収集分野です。 POSTメソッドは、このフィールドのサブスクリプションを使用する場合は、リクエストヘッダに196.0 zuoraバージョンにパラメータを設定します。 zuoraパラメータは大文字と小文字が区別されたバージョンです。
マイナーバージョンは、リクエストヘッダに指定されていない場合、すべてのフィールドのREST APIの場合、デフォルトでは、Zuoraはあなたの統合を壊す回避するために、REST APIの最低限のマイナーバージョンを使用します。
次の図は、キーオブジェクトZuoraの高レベルのビューを提供します。サイズを変更するには、新しいタブで開くには画像をクリックしてください。
アクションは、自然の中でのバッチな操作です。たとえば、「更新」、「作成」「削除」、およびその他の操作は、一度に50個のオブジェクトへの変更を可能にします。その日が、その後の「queryMore」操作によって返される追加ページを必要とする前に、「クエリ」の操作は、一度に戻って2000年の結果までのレコードが返されます。
このようなサブスクリプションをアップグレードするように、変更するサブスクリプションのコールを改正使用します。
コールを改正：
10オブジェクト改正まで。
10分の時間ウィンドウごとのテナント1,000のコール。
あなたが近づくか、この制限を超える場合は、429エラーが表示されます。マルチスレッドを使用すると、より迅速に、この限界に近づくようになります。
改正回のコールで、あなたの改正の目的の一つが失敗した場合、全体の呼び出しは失敗します。
次のフィールドは、常にこのコールのために必要とされています。
REST APIを介して新しい会計コードを作成する方法lýsirこのリファレンス。会計コードはすぐにそれが作成されているようにアクティブになります。
あなたがテナントにZ-ファイナンスを有効にしている場合は、許可Z-ファイナンス会計コードを作成している必要があります。Z-ファイナンスの役割を参照してください。
会計期間会計期間のIDで閉じます。
あなたのテナントにZuoraファイナンスを有効にする必要があります。あなたは、ユーザー権限の管理閉じるプロセスと実行残高試算表を持っている必要があります。役割ファイナンスを参照してください。制限
あなたが会計期間にZuoraを閉じると、自動的にその期間の試算表を実行しています。正常な応答のみ会計期間は終了いたしましたことを意味し、それは裁判のバランスが正常に完了しているとは限りません。
クレジットカードのお支払い方法、請求先に連絡し、販売-する連絡オプションで顧客アカウントを作成する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。そのサブスクリプションのサブスクリプション、請求書を作成し、オプション、およびデフォルト支払方法を通じて支払いを収集するために、このメソッドを使用します。トランザクションはアトミックです。何らかの理由でいずれかの部分が失敗した場合、トランザクション全体がロールバックされます。
このAPIの呼び出しは、CORSが有効になっているので、あなたは、コールを呼び出すために、クライアント側のJavaScriptを使用することができます。詳細については、CORS Zuora RESTのページをご覧ください。
デフォルト値はcustomerAcceptanceDateとserviceActivationDateために次のように設定されています。
指定したサブスクリプションの改正に関する詳細な情報を取得します。
アカウント、サブスクリプション、または請求書にドキュメントを添付するマルチパート/フォームデータファイルに添付ファイルを追加REST要求を使用してください。
すべての製品、機能、およびそれらに対応する料金プラン、料金を含め、全体の製品カタログを取得する方法をlýsirこのREST APIリファレンス。製品は、フィールドUpdatedDate上の新しい順に返されます。
REST APIは、製品、製品の料金プランと料金の作成や更新をサポートしていません。これらのタスクは、WebベースのUIで、またはSOAP APIを介して行うことができます。
料金プランと料金レートの計画では、REST APIは、最大配列サイズを持っています。詳細については、配列サイズを参照してください。
数要約料収入を指定することで、要約料収入の詳細を取得する方法lýsirこのREST APIリファレンス。応答は、電荷収入サマリー項目に関連付けられたすべての収益が含まれています。
有効なユーザーの資格情報に基づいてZuora REST APIサービスへの接続を確立します。
これは、ユーザーを認証し、REST APIへの後続の呼び出しを許可するために使われているAPI呼び出しのセッションクッキーを返します。接続への呼び出しは、データにアクセスするためにZuora REST APIを使用する前に必要な最初のステップです。
資格情報は、APIサービスにアクセスする権限を持つユーザーアカウントに属している必要があります。
他の場所で述べたように、強く、APIの活動ZuoraはZuora UIへのログインに使用したアカウントに使用されることはありませんことをお勧めします。アカウントがUIにログインするために使用されると、それはAPIを使用した場合、最終的に認証の失敗につながる可能性が定期的に強制的にパスワードを変更した場合、対象となる場合があります。
CRUD：連絡先を作成
CRUD：CreditBalanceAdjustmentを取得
この機能は、限られた入手可能です。あなたは機能へのアクセス権を持っているしたい場合は、Zuoraグローバルサポートにリクエストを送信してください。
外国為替相場Zuoraからどのようにlýsirカスタムクエリへのこの参照。カスタムプロバイダを使用し、輸入外国為替レート質量作用と速度の為替レートをアップロードする場合にのみ、あなたは、為替レートを照会するために、このAPIメソッドを使用することができます。あなたは為替レートのプロバイダのデフォルトの為替レートを取得したい場合は、OANDAは、データソースの輸出のために外貨換算を参照してください。
Zuoraで通貨換算の詳細については、外貨換算を参照してください。
CRUD：エクスポートを作成します。
CRUD：フィーチャーを取得
そのファイルIDを指定することでファイルを取得します。あなたは、期間会計などの収入の詳細を報告する報告書、ならびにこのようなPDFファイルの請求書などの他のファイルを取得することができます。
"：$のUSER_NAME apiAccessKeyId" -Hカール-H -iによる「apiSecretAccessKey：$ PASSWORD
"
-H「同意する：アプリケーション/ pdf "を
-X GET
https://apisandbox-api.zuora.com/rest/v1/files/2c92c08c55534cf00155581fb474314d
-o /Users/jsmith/Downloads/invoiceFile1.pdf
請求書のPDFは/ユーザ/ JSMITH /ダウンロードと名付けinvoiceFile1.pdfにダウンロードされます。
最大エクスポートファイルのサイズは2047メガバイトです。あなたはこの制限を越える大規模なデータ要求がある場合は、Zuora 403 HTTPレスポンスコードで次のようになります。
<セキュリティ：最大オブジェクトサイズ> 2047メガバイト
追加の支援が必要な場合はZuoraグローバルサポートにリクエストを送信します。
私たちは、大きなファイルの最適化があなたのためのオプションがあるかどうかを判断するためにあなたと一緒に作業することができます。
有効CORS API呼び出しを処理するために使用される署名とトークン値を返す方法lýsirこのユニークなREST APIリファレンス。
コールは、支払いページhostedpages具体的に構成メタデータ、ページID、ページのバージョン、お支払い方法の種類を返します。
REST支払いページ用のバージョン固有および一般的な要求は次のとおりです。
あなたは、対応するテナントの設定は、例えば、リクエストパラメータが無効に設定する支払いページのバージョン2.0を2に設定し、有効にしていない場合は、エラーが表示されます。
CRUD：インポートを取得
CRUD：InvoiceAdjustmentを作成します。
CRUD：InvoiceItemAdjustmentを取得
CRUD：InvoiceItemを取得
CRUD：InvoicePaymentを作成します。
CRUD：InvoiceSplitItemを取得
CRUD：InvoiceSplitを取得
CRUD：請求書を作成します。
ジャーナルランを作成する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
REST APIを介して質量アクションを実行する方法lýsirこのリファレンス。質量アクションを実行する方法の詳細は、マスアップデータを参照してください。
このAPIメソッドを使用して、あなたが実行したい質量作用に関するデータを持つ.csvファイルを含むmultipart / form-dataリクエストを送信します。 Zuoraは、鍵を返し、その後、非同期質量作用を処理します。あなたは質量作用の結果の詳細を取得するためにキーを使用することができます。
通知履歴を取得する方法のための吹き出しlýsirこのREST APIリファレンス。
詳細については、通知とコールアウトを参照してくださいし、作成と編集通知。
請求書を生成し、指定したアカウントの支払いを収集します。
この方法では、請求書に生成することができます請求書を生成し、支払いを収集し、あるいは単に指定された既存の請求書に支払いを収集します。顧客のデフォルトのお支払い方法が使用され、全額が原因で収集されます。操作は、指定したパラメータに依存します
その顧客のために生成された1つ以上の新しい請求書を作成し、請求書（複数可）でのお支払いを収集するには、フィールド空invoiceIdを残します。
既存の請求書でのお支払いを収集するには、請求書のIDを指定します。
操作はアトミックです。いずれかの部分が失敗した場合、操作全体がロールバックされます。
サブスクリプションの非常に高い数を持つアカウントでこのメソッドを使用するときにタイムアウトが発生することがあります。
CRUD：PaymentMethodSnapshotを取得
CRUD：PaymentMethodTransactionLogを取得
顧客アカウントの新しいクレジットカードの支払方法を作成する方法lýsirこのREST APIリファレンス。
このAPIの呼び出しは、CORSを有効になっています。コールを呼び出すために、クライアント側のJavaScriptを使用してください。 CORS Zuora RESTはより多くの情報を参照してください。
CRUD：PaymentTransactionLogを取得
CRUD：お支払いを作成します。
CRUD：ProductFeatureを取得
CRUD：ProductRatePlanChargeTierを取得
CRUD：ProductRatePlanChargeを取得
CRUD：ProductRatePlanを作成します。
CRUD：製品を作成します。
文書の呼び出しは、引用文書を生成し、URLはドキュメントを生成し返します。あなたは直接返されたURLを介して生成された引用のファイルにアクセスすることができます。
文書はZuoraの声から電話を使用する必要があります。
最大エクスポートファイルのサイズは2047メガバイトです。セキュリティ：最大オブジェクトサイズ> 2047メガバイト がこの上限を超える大規模なデータ要求がある場合は、Zuora 403 HTTPレスポンスコードで次のようになります
追加の支援が必要な場合はZuoraグローバルサポートにリクエストを送信します。
私たちは、大きなファイルの最適化があなたのためのオプションがあるかどうかを判断するためにあなたと一緒に作業することができます。
CRUD：RatePlanChargeTierを取得
CRUD：RatePlanChargeを取得
CRUD：RatePlanを取得
CRUD：RefundInvoicePaymentを取得
CRUD：RefundTransactionLogを取得
CRUD：払い戻しを作成します。
イベントlýsirこのREST APIリファレンス番号を指定して、収益イベントによって収入を得る方法を詳しく説明します。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
数要約料収入を指定することで、収益の要約料収入の各項目の詳細を取得する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
購読料のIDに関連付けられた電荷を指定することで、収益認識ルールを取得する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
請求書の項目の収益スケジュールを作成し、開始日と終了日を指定することで、収益認識を配布する方法については、このlýsirREST APIリファレンス。
RESTのAPI 2.0は、支払いページCORS（クロスオリジンリソースの共有）を有効に使用されるため、デジタル署名を必要としています。 POST rsa_signatures呼び出しが生成され、デジタル署名のために必要なトークンを返し、支払いページ2.0を形成します。あなたは支払いページ2.0にアクセスするためのクライアントのためにそれを生成した署名を渡す必要があります。
あなたは2.0支払いページを実装する際RESTこのサービスにのみ使用してください。
収入の自動化の開始日を取得する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
CRUD：SubscriptionProductFeatureを取得
プレビューモードで新しいサブスクリプションを作成する方法lýsirREST APIリファレンス。この呼び出しは、有効な顧客アカウントを必要としません。アカウントを作成する前に、潜在的な顧客に完全な詳細および電荷を有する新しいサブスクリプションのプレビューを表示するために、または既存の顧客に料金をすべてコミットする前にプレビューでサブスクリプションをさせるために使用することができます。
仕訳の概要を作成します。
手動仕訳入力の要約を作成する方法lýsirこのREST APIリファレンス。リクエストとレスポンスフィールドの説明とサンプルコードが提供されています。
集計通貨の詳細については外貨換算の要約仕訳を参照してください。
CRUD：TaxationItemを作成します。
請求書を取得します
請求書のために指定されたアカウントを取得します。請求書はupdatedDateによって新しい順に返されます。
CRUD：UnitOfMeasureを作成します。
CSV形式の1つ以上のアカウントのデータ使用量を転記またはインポートする方法lýsirこのREST APIリファレンス。何のパスまたはクエリパラメータはありません。日付は、HTTP multipart / form-dataのPOSTメソッドを使用して、ユーザーのテナントに適用uploadeです。
アップロードファイルの内容は、UIのインポートツールで使用される形式に従わなければなりません。これは、対応する拡張子.csvファイルでカンマ区切り値（CSV）ファイルである必要があります。ファイルサイズが4メガバイトを超えてはなりません。テンプレートファイルの使用状況をダウンロードするには、ここをクリックしてください。
アップロードが完了すると、実際にファイルの内容を処理する前に、theAPIは、受信したファイルのバイト数と、インポート・プロセスの状態を確認するためのURLを含む応答を返します。そのURLにある5つの可能な結果のキャンセル、完了、保留、処理を表示し、失敗した）のみ完了ステータスは、インポートが成功したことを示しています。操作はアトミックです。すべてのレコードが失敗した場合、ファイルは拒否されます。その場合に、全体のインポートはロールバックされ、すべての記憶されたデータは元の状態に戻されます。
現在のインポートのステータスを表示するには、そのようなステップは、インポートが失敗した可能性が理由の詳細を提供する追加POSTMAN.Thisなどのツールを使用してcheckImportStatus応答によって得られたステータスのURLを入力します。
アップロードが正常に終了した後の情報を管理するには、WebベースのUIを使用しています。
originalwww.zuora.com
translate byGoogle Translate API
[Amazon商品]
