Documentació de l'API

Integreu Family-Tree.Online a les vostres aplicacions. La nostra REST API us permet crear, llegir i actualitzar dades de l'arbre genealògic.

Autenticació

Accés segur a l'API

Claus d'API

Per accedir a l'API cal una clau d'API de la configuració del compte. Passeu la clau a la capçalera Authorization.

Authorization: Bearer YOUR_API_KEY

Obtenir una clau d'API

1. Inicieu sessió al compte
2. Aneu a «Configuració» → «API»
3. Creeu una clau d'API nova
4. Copieu la clau i deseu-la en un lloc segur

Arbres genealògics

GET
/api/v1/trees

Obtenir la llista de tots els arbres genealògics de l'usuari

limit integer opcional
offset integer opcional
Exemple de sol·licitud:
curl -X GET "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY"
Exemple de resposta:
{ "data": [ { "id": 1, "name": "Família Ivanov", "description": "Arbre genealògic principal", "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

Crear un arbre genealògic nou

name string obligatori
description string opcional
Exemple de sol·licitud:
curl -X POST "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Família Petrov", "description": "Arbre genealògic nou" }'

Membres de la família

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

Obtenir la llista de tots els membres de la família d'un arbre

tree_id integer obligatori
search string opcional
Exemple de resposta:
{ "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

Afegir un membre nou de la família

firstname string obligatori
secondname string obligatori
birthday date opcional
gender string opcional

Relacions familiars

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

Crear una relació entre parents

related_human_id integer obligatori
relationship_type string obligatori

SDK i biblioteques

Biblioteques llestes per a llenguatges de programació populars

JavaScript/Node.js

Biblioteca oficial per a JavaScript i Node.js. Compatible amb navegadors i entorns de servidor.

Instal·lar

Python

Biblioteca Python amb suport per a sol·licituds asíncrones. Integració fàcil amb Django i Flask.

Instal·lar

PHP

Biblioteca PHP amb suport de Composer. Compatible amb Laravel i Symfony.

Instal·lar

Límits de freqüència

Límits per a un rendiment estable de l'API

Límits de sol·licituds

Tipus de compte Sol·licituds per minut Sol·licituds per dia
Basic 60 1,000
Premium 300 10,000
Family 1,000 50,000

Preguntes freqüents

A punt per començar la integració?

Obtingueu una clau d'API i comenceu a integrar Family-Tree.Online a les vostres aplicacions

Crea un compte Contacteu-nos