API Key認証

SquadbaseにデプロイしたFastAPIなどのフレームワークで構築したサーバーサイドアプリケーションには、追加のコードなしで自動的にAPI Key認証による保護を追加します。 これによって、StreamlitやNext.jsなどで構築したアプリケーションから安全にサーバーサイドのAPIを呼び出すことができます。

API Keyの作成

Squadbaseのアカウント設定からAPI Keyを作成することができます。API Keyは使用することができるチームやプロジェクトを細かく制限することができます。

1. 画面左下のアカウント設定からAPI Keysを選択。
2. +Createボタンをクリックし、API Keyの名前を設定。
3. アクセスを許可するチーム・プロジェクトを選択しCreate API Keyをクリックすると、API Keyが作成されます。

API Keyを使用したアプリケーションへのアクセス

API Keyを使用してアプリケーションにアクセスする方法を紹介します。デプロイされたアプリケーションにアクセスする際にHTTPヘッダーに x-api-key を指定することで、API Key認証を行うことができます。

curl -X GET "https://your-subdomain.squadbase.app/" \
  -H "x-api-key: your-api-key"

import requests

response = requests.get("https://your-subdomain.squadbase.app/", headers={"x-api-key": "your-api-key"})
print(response.json())

import axios from "axios";

const response = await axios.get("https://your-subdomain.squadbase.app/", {
  headers: {
    "x-api-key": "your-api-key",
  },
});
console.log(response.data);