SPAJAM 2025 API (1.0.0)

Download OpenAPI specification:

SPAJAM 2025のAPI仕様書

Auth

認証関連の操作

サインアップ

新規ユーザを作成

Authorizations:
apiKey
Request Body schema: application/json
required
email
required
string <email>

ユーザのメールアドレス

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "expires_at": 1758013496,
  • "refresh_token": "42c5rljcaysp",
  • "user": {
    }
}

サインイン

既存ユーザでサインイン

Authorizations:
apiKey
query Parameters
grant_type
required
string
Value: "password"
Example: grant_type=password

認証タイプ

Request Body schema: application/json
required
email
required
string <email>

ユーザのメールアドレス

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com",
  • "password": "password123"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "expires_at": 1758013872,
  • "refresh_token": "aoxiuchy5ld4",
  • "user": {
    },
  • "weak_password": null
}

Test

テスト用エンドポイント

認証なし接続確認

認証なしの接続確認用エンドポイント

Authorizations:
anonKey

Responses

Response samples

Content type
application/json
{
  • "message": "pong"
}

認証なしDB問い合わせあり接続確認

認証なし、DB問い合わせありの接続確認用エンドポイント(データベースからランダムな挨拶メッセージを取得)

Authorizations:
anonKey

Responses

Response samples

Content type
application/json
{
  • "message": "こんにちは!"
}

認証あり接続確認

認証ありの接続確認用エンドポイント(認証されたユーザの情報を返す)

Authorizations:
accessToken

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}