メインコンテンツまでスキップ

SaaS版 クイックスタート

Authorization Code 認証でトークンを取得し、SSE 経由でエージェントと会話するまでの手順を解説します。

はじめに

SaaS版の API を利用するための最短ステップを紹介します。以下の4つのステップでエージェントとの会話を開始できます。

対象範囲

このクイックスタートは Web アプリケーション(サーバー側で Client Secret を保持できる Confidential Client)向けの手順です。SPA / モバイルアプリ(Public Client)の場合は PKCE フローが必須となるため、本クイックスタートはそのままでは利用できません。詳細は認証ガイドを参照してください。

前提条件
  • API オプションの申込が完了していること
  • Console にログインできること(developer ロール以上)
  • Console で Web アプリケーション タイプのクライアントを作成済みであること(Consoleガイド
  • 以下の情報を取得済みであること:
    • Client ID - 作成したアプリケーションの ID
    • Client Secret - アプリケーションのシークレット
    • Redirect URI - Console に登録済みのリダイレクト先 URL

Step 1: 認証情報の確認

Console のアプリ詳細画面で、以下の情報を確認してください。

Client ID: your-app-001
Client Secret: (hidden)
Redirect URI: http://localhost:3000/callback

Step 2: 認可コードの取得

ブラウザで認可エンドポイントにアクセスし、ログイン後に認可コードを取得します。

認可 URL の構築

以下の URL をブラウザで開いてください。client_idredirect_uristate を自分の値に置き換えてください。

https://auth.fd.agenticstar.tm.softbank.jp/federation/auth/v1/authorize?response_type=code&client_id=<your-client-id>&redirect_uri=<your-redirect-uri>&state=<random-state-value>

パラメータ

  • response_type: code 固定
  • client_id: Step 1 で確認した Client ID
  • redirect_uri: Console に登録済みの Redirect URI(URL エンコード済み)
  • state: CSRF 対策用のランダム文字列(強く推奨)

ログインと認可

  1. ブラウザにログイン画面が表示されます。普段と同じアカウントでログインしてください。
  2. 同意画面が有効になっているアプリケーションの場合、初回利用時やスコープ追加時に同意画面が表示されます。内容を確認し、許可してください。

認可コードの受け取り

認可が完了すると、ブラウザが redirect_uri にリダイレクトされます。URL に含まれる code パラメータが認可コードです。

http://localhost:3000/callback?code=AUTH_CODE_VALUE&state=<random-state-value>
警告
  • state を指定した場合は、レスポンスの値がリクエスト時と一致することを必ず検証してください(CSRF 対策)
  • 認可コードの有効期限は短いため、すぐに次のステップでトークンに交換してください

Step 3: トークンの取得

認可コードをアクセストークンに交換します。サーバー側で以下のリクエストを実行してください。

リクエスト例

Exchange authorization code for token
1curl -X POST https://auth.fd.agenticstar.tm.softbank.jp/federation/auth/v1/token \
2-H "Content-Type: application/x-www-form-urlencoded" \
3-d "grant_type=authorization_code" \
4-d "code=<auth-code>" \
5-d "redirect_uri=<your-redirect-uri>" \
6-d "client_id=<your-client-id>" \
7-d "client_secret=<your-client-secret>"

パラメータ

  • grant_type: authorization_code 固定
  • code: Step 2 で取得した認可コード
  • redirect_uri: Step 2 と同じ Redirect URI
  • client_id: Step 1 で確認した Client ID
  • client_secret: Step 1 で確認した Client Secret

レスポンス例

JSON
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"id_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_expires_in": 86400,
"scope": "openid chat:exec"
}
トークンの有効期限

expires_in に指定された秒数の間、トークンが有効です。期限切れ後は refresh_token を使ってトークンをリフレッシュできます。詳細は認証ガイドを参照してください。

Step 4: Chat API 呼び出し

取得したアクセストークンを使用して、SSE(Server-Sent Events)経由で Chat API を呼び出します。ストリーム形式でエージェントからのリアルタイム応答を受け取ります。

リクエスト例

Create chat completion
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/chat/completions \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "model": "AGENTIC STAR",
6 "stream": true,
7 "messages": [
8 {
9 "role": "user",
10 "content": "こんにちは"
11 }
12 ]
13}'

パラメータ

  • <access_token>: Step 3 で取得したアクセストークン
  • stream: true: SSE ストリーミングを有効化
  • messages: ユーザーからのメッセージ。配列形式で複数メッセージも可能

レスポンス例(SSE ストリーム)

data: {"choices":[{"delta":{"content":"こんにちは"}}]}

data: {"choices":[{"delta":{"content":"、お手伝い"}}]}

data: {"choices":[{"delta":{"content":"できることはありますか"}}]}

data: [DONE]

上記は読みやすさのため delta.content のみを抜粋しています。実際のチャンクには createdAt / model / choices[].index / finishReason などの追加フィールドが含まれます。完全なフォーマットは API リファレンス を参照してください。

SSE ストリーミングについて

レスポンスは Server-Sent Events(SSE)形式で、チャンク単位でリアルタイムに送信されます。各チャンクは data: JSON 形式です。data: [DONE] で会話が完了します。詳細は ストリーミングガイド を参照してください。

次のステップ

さらに詳しい情報と実装パターンについて、以下のドキュメントを参照してください。