Translation disclaimer

Documentation is written in English and subsequently translated. This page, therefore, might not have the most up-to-date content. If any questions arise relating to the accuracy of the translated content, please refer to the English version of the page.

Menu

API原則

このセクションでは、市場をリードするAPIを作成するために当社が準拠する標準の概要を説明します。


API設計アプローチ

当社は使い慣れたツールをご利用いただくために、業界標準の規則に従っています。当社のモジュラーAPIは特定の使用例でご利用いただけます。尚、モジュラーAPIは支払の流れを最適化するように設計されています。 また、当社のAPIはセルフサービスを可能にするように設計されています。APIは貴社に次の手順を示し、簡単に学習でき、そして貴社の統合をサポートする文書と認定を提示します。

APIはどのように機能しますか?

  • 貴社のシステムと簡単に統合できるように、アクションをRestful HTTPリソースとして提示しています

    まず、ルートリソースを取得して、利用可能なものを表示することから始めます。 当社は、標準化されたHTTP方法(POST、PUT、GETなど)を実行できるリソースを提供しています。

  • 貴社の処理を最適化するための動的なアクションリンク

    当社のAPIサービスを利用して、特定の決済処理に合わせて次のアクションを最適化できます。

    動的なアクションリンクをハイパーメディアリンクとして返し、決済処理を直感的で学習が簡単のものにし、また貴社が間違いを犯すことを防ぎます。

    注記:動的な次のアクションリンクは、個々の取引タイプに固有のものです。ベースURLを除く暗号化アクションリンクデータの最大長は最大1024文字です。

    以下の例は、ルートリソースに照会を実行したときに返される_linksオブジェクトです。これらのリンクを使用すると、支払を承認したり、トークンを作成したりできます。

    Copied!
    {
      "_links": {
          "payments:authorize": {
          "href": "https://try.access.worldpay.com/payments/authorizations"
          },
          "tokens:tokens": {
          "href": "https://try.access.worldpay.com/tokens"
          }
      }
      }
  • 様々な使用例をサポートするモジュラーリソースと複合リソース

    一部のアクションリンクは動的であり、最適な支払の流れをガイドします。当社のAPIは、支払パターンと結果を最適化できるように、APIを貴社の処理システムに統合できるツールセットとして設計されています。 尚、次のアクションリンクの一部は複合であり、1回の呼び出しで複数のアクションを実行できます。

  • 様々なインタラクティブな処理間で一貫した言語

    当社はAPIの統合と使用の簡易化に重点を置いており、様々なサービスで同じ言語を使用することを目指しています。尚、同じ言語を使うことで、学習しやすく、使いやすい、迅速な統合を保証することができるのです。

  • 学習性のためのハイパーテキストアプリケーション言語(HAL)

    HALは、APIリソースとリンクの形式を定義します。HALは、APIリソース間のハイパーリンクを一貫させ、簡単にします。またHALを利用することで、様々なAPIを相互リンクして、より消費可能で探索可能なエクスペリエンスを提供することができます。

    HALは、機械と人間の両方が判読でき、API参考文献からコンテキストを取得できます。

    標準ライブラリで使用できるように、この規則に従って、リソースとアクションのリンクを構造化しています。

  • APIバージョンの使用を制御するメディアタイプ

    メディアタイプは、JSONファイルの性質と形式を指定します。ファイルの処理方法を定義します。リクエストの形式は標準を満たしていなければなりません。尚、満たさない場合、リクエストは受け入れられません。

    メディアタイプはContent-Typeヘッダーで定義され、APIバージョンを定義し、API全体で標準化されています。

    Copied!
    Content-Type: application/vnd.worldpay.payments-v6+json

ベストプラクティス

Access Worldpayは、サービス応答のヘッダーでWP-CorrelationIdを返します。これをログに記録することを強くお勧めします。各サービスリクエストを確認するためにWP-CorrelationIdを使用します。

バージョン管理

上記の例は、Payments API(支払API)を現行バージョン6でご利用いただけることを示しています。当社は、最新の機能を提供するためにAPIの更新に努めています。変更点とリリース日は、破壊的、非破壊的に関係なく、各API文書の下部に記されています。例を挙げると、Payments API(支払API)のバージョン管理/変更ログはこちらで確認することができます。

APIを更新すると、以前のスキーマが最新の更新でサポートされなくなる可能性があります。文書は常に最新バージョンのAPIを反映していますが、以前のバージョンのスキーマを見つけるには、API参考文献を参照してください。

以前のAPIの文書は、旧バージョンのセクションでご確認いただけます。

なぜ新しいAPIバージョンをリリースするのですか?

APIに新機能を導入するため。破壊的変更が発生する可能性があります。


新しいAPIバージョンは常に破壊的変更を導入しますか?

通常はそうです。以前のバージョンのAPIでは認識できない新たなパラメーターをリクエストに導入することがあります。


バージョンには下位互換性がありますか?

いいえ、各バージョンは異なるスキーマを受け入れる場合があります。文書にはAPIの最新バージョンの大半が反映されているため、API参考文献で各バージョンのスキーマについて詳しく説明します。

破壊的変更の定義

Access API(アクセスAPI)に統合する際の復元力を保証するには、Worldpayが別のバージョンに移行せずに次の変更を行う可能性があることを考慮しなければなりません。

応答で:

リクエストで

重要:文書に記録されていない要素を送信すると、エラーが返されます。

注記:上記の定義以外の変更については、Worldpayは新しいバージョンを作成します。現在の標準については、形式ページでご確認ください。


セキュリティのベストプラクティスをよく理解してください。