ラッパーAPI

ブロックチェーン・アプリケーション・ビルダーの拡張バージョンでは、APIゲートウェイ用のラッパーAPIを生成でき、各チェーンコード・メソッドの専用エンドポイントをサポートします。

ラッパーAPIは、Oracle Blockchain Platformエンドポイントの抽象化レイヤーです。ラッパーAPIでは、一般的なパラメータとAPI固有のエンドポイント名の構成がサポートされており、使用状況と明確さを簡素化できます。

Oracle Blockchain Platformのベース・バージョンでは、APIエンドポイントには、チェーンコード名、タイムアウトおよび同期値、引数(メソッド名を含む)、チャネル名、インスタンスURLなどのパラメータが必要です。これらのパラメータは、すべての呼出しとともに渡す必要があります。これらのパラメータのほとんどはすべてのメソッドに共通であるため、ラッパーAPI機能を使用して各メソッドのエンドポイントを作成し、そのメソッド・パラメータのみを使用してコールできます。共通エンドポイント(トランザクションまたは問合せ)のかわりに、各メソッドのカスタム・エンドポイント名を使用できます。Oracle Blockchain PlatformのAPIエンドポイントはPOSTリクエストを使用しますが、ラッパーAPIはPOSTリクエストとGETリクエストの両方をサポートしています。APIゲートウェイ認証メカニズムを使用して、ラッパーAPIを使用した認証の追加レイヤーを追加することもできます。

次の例は、Oracle Blockchain PlatformのcreateAccountメソッドAPIを示しています。

エンドポイント: https://<blockchain_instance>:7443/restproxy/api/v2/channels/<channelName>/transactions

{
    "chaincode": "{{bc-chaincode-name}}",
    "args": [
        "createAccount",
        "{{bc-org-id}}",
        "{{bc-user-id}}",
        "fungible",
        "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}"
    ],
    "timeout": {{bc-timeout}},
    "sync": {{bc-sync}}
}

ラッパーAPIを構成する場合、次の例に示すように同じメソッド・コールを実行できます。

エンドポイント: https://<gateway-hostname>/<deployment-path-prefix>/<route-path>

{
    "orgId": "{{bc-org-id}}",
    "userId": "user1",
    "tokenType": "fungible",
    "dailyLimits": "{\"max_daily_amount\":10000,\"max_daily_transactions\":100}",
}