MENU

API認証を強化するためのYAMLスキーマとGoogle Apps Scriptの統合

現代のウェブ開発において、APIのセキュリティは非常に重要です。特に、APIを公開する場合は、認証機構を実装して不正アクセスを防ぐことが必要です。この記事では、トークン認証を利用してAPIのセキュリティを強化する方法について、YAMLを使ったAPIスキーマ定義とGoogle Apps Script（GAS）による実装方法を詳しく解説します。

トークン認証の基本

トークン認証とは、リクエストに含まれるトークンを確認することで、アクセスを許可する方法です。これはパスワードのような役割を果たし、正しいトークンを持つリクエストのみを許可します。以下に、トークン認証を利用したAPIをYAMLスキーマで定義し、GASで実装する方法を示します。

YAMLでのAPIスキーマ定義

まず、OpenAPI仕様を使用して、APIスキーマをYAMLで定義します。ここでは、/authenticateエンドポイントに対してPOSTリクエストを行い、リクエストボディにトークンを含める形で認証を行います。

openapi: 3.1.0
info:
  title: Token Authentication API
  description: API for authenticating requests using a token
  version: 1.0.0
paths:
  /authenticate:
    post:
      summary: Authenticate using a token
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                token:
                  type: string
                  description: The token used for authentication
      responses:
        '200':
          description: Authentication successful
          content:
            text/plain:
              schema:
                type: string
                example: Authorized
        '401':
          description: Authentication failed
          content:
            text/plain:
              schema:
                type: string
                example: Unauthorized

Google Apps Scriptでの実装

次に、上記のスキーマに基づいてGoogle Apps Scriptでトークン認証を実装します。以下は、POSTリクエストのボディからトークンを取得し、検証するスクリプトです。

function doPost(e) {
  // リクエストボディからトークンを取得
  var token = e.parameter.token;

  // トークンをチェック
  if (token !== "MY_SECRET_TOKEN") {
    // トークンが間違っている場合のレスポンス
    return ContentService.createTextOutput("Unauthorized").setMimeType(ContentService.MimeType.TEXT);
  }

  // トークンが正しい場合のレスポンス
  return ContentService.createTextOutput("Authorized").setMimeType(ContentService.MimeType.TEXT);
}

クライアントからのリクエスト送信

最後に、クライアントからPOSTリクエストを送信する方法です。JavaScriptを使用してリクエストを送信する例を以下に示します。

var url = 'https://script.google.com/macros/s/YOUR_SCRIPT_ID/exec';

var data = {
  token: 'MY_SECRET_TOKEN'
};

var options = {
  method: 'post',
  contentType: 'application/x-www-form-urlencoded',
  payload: data
};

UrlFetchApp.fetch(url, options);

まとめ

この方法を使用することで、APIのセキュリティを向上させることができます。YAMLでAPIスキーマを定義し、それに基づいてGoogle Apps Scriptでトークン認証を実装することで、認証プロセスが明確になり、管理が容易になります。また、HTTPSを使用してリクエストを暗号化することで、さらにセキュリティを強化できます。

このように、APIの認証を強化するための一連の手順を理解し、実装することで、安全で信頼性の高いAPIを提供することができます。

コラム