Skip to main content

ベース URL

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

認証

すべてのリクエストで Authorization ヘッダーに API キーを含めてください:
登録とセキュリティ要件については、認証セットアップガイドをご覧ください。

レスポンス形式

成功レスポンス

すべての成功した API レスポンスは以下の構造に従います:

ページネーション

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

データ形式

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

コンテンツタイプ

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