メインコンテンツへスキップ

​
ベース URL

Legitmark API は REST 原則に基づいて構築されています。データのセキュリティ、整合性、プライバシーを向上させるため、すべてのリクエストで HTTPS を強制しています。API は HTTP をサポートしていません。 すべてのリクエストには以下のベース URL が含まれます： 
https://api.legitmark.com

​
認証

すべてのリクエストで Authorization ヘッダーに API キーを含めてください： 
const headers = {
  'Authorization': 'Bearer leo_xxxxxxxxx',
  'Content-Type': 'application/json'
};
登録とセキュリティ要件については、認証セットアップガイドをご覧ください。

​
レスポンス形式

​
成功レスポンス

すべての成功した API レスポンスは以下の構造に従います： 
{
  "success": true,
  "message": "操作が正常に完了しました",
  "data": {
    // snake_case 形式のレスポンスデータ
  },
  "metadata": {
    // ページネーションメタデータ（リストエンドポイント用）
    "total_count": 100,
    "page_number": 1,
    "total_pages": 10,
    "page_size": 10
  }
}

​
ページネーション

リストエンドポイントはクエリパラメータを使用したページネーションをサポートしています：
  • page_number：ページ番号（デフォルト：1、最小値：1）
  • page_size：1ページあたりのアイテム数（デフォルト：20、最大値：100）
  • sort_by：ソートフィールド
  • sort_direction：ソート方向（asc または desc）
例： 
GET /api/users?page_number=1&page_size=20&sort_by=created_at&sort_direction=desc

​
データ形式

  • すべてのリクエストとレスポンスデータは snake_case 形式を使用
  • 日付は ISO 8601 形式（例：2024-01-01T00:00:00.000Z）
  • リソース識別子には UUID を使用
  • タイムスタンプには created_at と updated_at フィールドを含む

​
コンテンツタイプ

  • リクエスト Content-Type：application/json
  • レスポンス Content-Type：application/json
  • すべてのリクエストには適切な Content-Type ヘッダーを含める必要があります