createToken

クリエイトトークン（Laravel Sanctum）

意味新しいAPIトークンの生成

createTokenとは？

createTokenは、Laravel Sanctumで新しいAPIトークンを生成するためのメソッドです。ユーザー認証後にこのメソッドを呼び出すことで、アプリケーションのAPIにアクセスするための新しいトークンを作成できます。

createTokenの具体的な使い方

APIトークン作成と使用の例

use App\Models\User;

// ユーザーを取得
$user = User::find(1);

// トークンを作成
$token = $user->createToken('api-token')->plainTextToken;

// トークンを使用してAPIリクエストを送信
$response = $client->request('GET', 'https://api.example.com/user', [
    'headers' => [
        'Authorization' => 'Bearer ' . $token,
        'Accept' => 'application/json',
    ],
]);

// レスポンスを表示
echo $response->getBody();

👇出力結果

{"id":1,"name":"John Doe","email":"[email protected]"}

この例では、まずユーザーを取得し、createToken()メソッドを使用して新しいAPIトークンを生成しています。生成されたトークンは、API呼び出しの認証に使用されます。ここでは、生成したトークンを使用してHTTPクライアントでAPIリクエストを送信し、レスポンスを表示しています。

createTokenに関するよくある質問

Q. createTokenの主な用途は？

A. createTokenメソッドの主な用途は、APIアクセスのための認証トークンを生成することです。これにより、ユーザーは生成されたトークンを使用してAPIにアクセスできるようになります。

Q. トークンの有効期限は設定できる？

A. はい、トークンの有効期限は設定できます。デフォルトでは無期限ですが、config/sanctum.phpファイルのexpiration設定を変更することで、トークンの有効期限を分単位で指定できます。

Q. 生成されたトークンの保存場所は？

A. 生成されたトークンはデータベースの personal_access_tokens テーブルに保存されます。plainTextTokenで取得できる文字列は、このテーブルに保存されたトークンのハッシュ値と、一意の文字列を組み合わせたものです。

Q. 複数のトークンを発行できる？

A. はい、1人のユーザーに対して複数のトークンを発行することができます。これは、ユーザーが複数のデバイスやアプリケーションからAPIにアクセスする場合に便利です。各トークンには異なる名前や能力を設定することもできます。

createTokenが学べる書籍の紹介

「プログラミング単語帳」を使って、プログラミングの単語を英単語のように学習してみませんか？
プログラミング単語帳には、LaravelのcreateTokenやSanctum::actingAs()、HasApiTokens、tokenCan()、などのような実務でよく使われる単語が数百以上収録されています。
この書籍には、プログラミングの単語の意味や読み方、単語の使い方がわかる例文などが掲載されており、いつでもどこでもプログラミングの学習ができます。

よく使われる単語にだけ絞って学習することができるので、効率的にプログラミングが学習できます。