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-дің тұрақты жұмысын қамтамасыз ететін шектеулер

Сұрау шектеулері

Тіркелгі түрі Минутына сұрау Күніне сұрау
Негізгі 60 1,000
Премиум 300 10,000
Отбасылық 1,000 50,000

Жиі қойылатын сұрақтар

Интеграцияны бастауға дайынсыз ба?

API кілтін алып, Family-Tree.Online-ды қолданбаларыңызға біріктіруді бастаңыз

Тіркелгі жасау Бізбен байланысу