APIキー認証

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

APIキーの作成

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

1. Portal画面の左サイドバー最下部のアカウントアイコンをクリックし、APIキーを開きます。
2. +Createボタンをクリックし、APIキーの名前を設定します。
3. アクセスを許可するチーム・プロジェクトを選択しAPIキーを作成をクリックすると、APIキーが作成されます。

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

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

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);