Tài liệu API

Tích hợp Family-Tree.Online vào ứng dụng của bạn. REST API cho phép tạo, đọc và cập nhật dữ liệu cây gia phả.

Xác thực

Truy cập API an toàn

Khóa API

Để dùng API, bạn cần khóa API từ cài đặt tài khoản. Truyền khóa trong header Authorization.

Authorization: Bearer YOUR_API_KEY

Lấy khóa API

1. Đăng nhập tài khoản
2. Vào "Cài đặt" → "API"
3. Tạo khóa API mới
4. Sao chép khóa và lưu an toàn

Cây gia phả

GET
/api/v1/trees

Lấy danh sách tất cả cây gia phả của người dùng

limit integer tùy chọn
offset integer tùy chọn
Ví dụ yêu cầu:
curl -X GET "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY"
Ví dụ phản hồi:
{ "data": [ { "id": 1, "name": "Gia đình Ivanov", "description": "Cây gia phả chính", "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

Tạo cây gia phả mới

name string bắt buộc
description string tùy chọn
Ví dụ yêu cầu:
curl -X POST "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Gia đình Petrov", "description": "Cây gia phả mới" }'

Thành viên gia đình

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

Lấy danh sách tất cả thành viên trong một cây

tree_id integer bắt buộc
search string tùy chọn
Ví dụ phản hồi:
{ "data": [ { "id": 1, "firstname": "Ivan", "secondname": "Ivanov", "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

Thêm thành viên gia đình mới

firstname string bắt buộc
secondname string bắt buộc
birthday date tùy chọn
gender string tùy chọn

Quan hệ gia đình

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

Tạo quan hệ giữa người thân

related_human_id integer bắt buộc
relationship_type string bắt buộc

SDK và thư viện

Thư viện sẵn có cho các ngôn ngữ lập trình phổ biến

JavaScript/Node.js

Thư viện chính thức cho JavaScript và Node.js. Hỗ trợ trình duyệt và môi trường máy chủ.

Cài đặt

Python

Thư viện Python hỗ trợ yêu cầu bất đồng bộ. Dễ tích hợp với Django và Flask.

Cài đặt

PHP

Thư viện PHP hỗ trợ Composer. Tương thích Laravel và Symfony.

Cài đặt

Giới hạn tốc độ

Giới hạn để đảm bảo API hoạt động ổn định

Giới hạn yêu cầu

Loại tài khoản Yêu cầu mỗi phút Yêu cầu mỗi ngày
Cơ bản 60 1,000
Premium 300 10,000
Gia đình 1,000 50,000

Câu hỏi thường gặp

Sẵn sàng bắt đầu tích hợp?

Lấy khóa API và bắt đầu tích hợp Family-Tree.Online vào ứng dụng của bạn

Tạo tài khoản Liên hệ