2-3. gatewayの設定

2-3-1. gatewayのConfigファイルに必要な情報について

configファイルに必要な情報は以下となります

・「プロバイダID」

・「集計用APIキー」

・「ツールラベル」

「商品識別コード」

情報を入手するにはTellus上への「商品の仮登録」が必要です。商品の仮登録の方法については「商品出品ガイド」をご確認ください。

「集計用APIキー」は商品のマーケット公開後に変更することができますが、gatewayの設定を新しい「集計用APIキー」に変更するまでカスタマーはAPIが利用できなくなります。

2-3-2. Configファイルの設定方法

configファイルのパスは「/etc/gateway/config.yml」です。

このファイルにWebAPIの受け口となるURLと、「集計用APIキー」、「プロバイダID」、「ツールラベル」、「商品識別コード」を記載します。

以下は、gatewayの設定例です。

openapi: '3.0.0'
info:
  title: APIリファレンスサンプル
  version: 1.0.0
servers:
  - url: https://example.com
paths:
  /test:
    get:
      description: testパスの説明
      parameters:
        - name: sample query
          description: Sample Description
          in: query
          required: true
          example: 20200401
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                  type: object
                  properties:
                    status: 
                      description: sample
                      type: string
        '400':
          description: Bad request
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter market access token for API

ファイルに上記設定を行うことでgatewayは https://example.com/test/ で受けたリクエストに対しマーケットトークンによる認証を行います。

トークンが、商品を購入済みのカスタマーのものであれば、リクエストをupstreamに設定されたサーバー localhost:3000/test/ にリバースプロキシします。



次へ