Документація 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

Бібліотека PHP із підтримкою Composer. Сумісна з Laravel і Symfony.

Встановити

Обмеження запитів

Обмеження для стабільної роботи API

Ліміти запитів

Тип облікового запису Запитів на хвилину Запитів на день
Базовий 60 1,000
Premium 300 10,000
Family 1,000 50,000

Поширені запитання

Готові почати інтеграцію?

Отримайте ключ API і почніть інтегрувати Family-Tree.Online у свої застосунки

Створити обліковий запис Зв’язатися з нами