API ドキュメント

Family-Tree.Online をアプリケーションに統合できます。REST API で家系図データの作成、読み取り、更新が可能です。

認証

安全な API アクセス

API キー

API にアクセスするには、アカウント設定の API キーが必要です。Authorization ヘッダーでキーを渡してください。

Authorization: Bearer YOUR_API_KEY

API キーの取得

1. アカウントにログイン
2. 「設定」→「API」へ移動
3. 新しい API キーを作成
4. キーをコピーして安全に保管

家系図

GET
/api/v1/trees

ユーザーのすべての家系図一覧を取得

limit integer 任意
offset integer 任意
リクエスト例:
curl -X GET "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY"
レスポンス例:
{ "data": [ { "id": 1, "name": "イワノフ家", "description": "メインの家系図", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-20T14:45:00Z" } ], "meta": { "total": 1, "limit": 20, "offset": 0 } }
POST
/api/v1/trees

新しい家系図を作成

name string 必須
description string 任意
リクエスト例:
curl -X POST "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "ペトロフ家", "description": "新しい家系図" }'

家族メンバー

GET
/api/v1/trees/{tree_id}/humans

家系図内のすべての家族メンバー一覧を取得

tree_id integer 必須
search string 任意
レスポンス例:
{ "data": [ { "id": 1, "firstname": "イワン", "secondname": "イワノフ", "birthday": "1980-05-15", "gender": "male", "is_alive": true, "created_at": "2024-01-15T10:30:00Z" } ], "meta": { "total": 1, "limit": 20, "offset": 0 } }
POST
/api/v1/trees/{tree_id}/humans

新しい家族メンバーを追加

firstname string 必須
secondname string 必須
birthday date 任意
gender string 任意

親族関係

POST
/api/v1/humans/{human_id}/relationships

親族間の関係を作成

related_human_id integer 必須
relationship_type string 必須

SDK とライブラリ

主要なプログラミング言語向けのすぐ使えるライブラリ

JavaScript/Node.js

JavaScript と Node.js の公式ライブラリ。ブラウザとサーバー環境に対応しています。

インストール

Python

非同期リクエスト対応の Python ライブラリ。Django と Flask への統合が容易です。

インストール

PHP

Composer 対応の PHP ライブラリ。Laravel と Symfony に互換性があります。

インストール

レート制限

API の安定した動作を保つための制限

リクエスト制限

アカウントの種類 1 分あたりのリクエスト数 1 日あたりのリクエスト数
ベーシック 60 1,000
プレミアム 300 10,000
ファミリー 1,000 50,000

よくある質問

統合を始める準備はできましたか?

API キーを取得して、Family-Tree.Online をアプリケーションに統合しましょう