Documentação da API

Integre o Family-Tree.Online nas suas aplicações. A nossa REST API permite criar, ler e atualizar dados da árvore genealógica.

Autenticação

Acesso seguro à API

Chaves de API

Para aceder à API, precisa de uma chave de API nas definições da conta. Passe a chave no cabeçalho Authorization.

Authorization: Bearer YOUR_API_KEY

Obter uma chave de API

1. Inicie sessão na sua conta
2. Vá a "Definições" → "API"
3. Crie uma nova chave de API
4. Copie a chave e guarde-a em segurança

Árvores genealógicas

GET
/api/v1/trees

Obter a lista de todas as árvores genealógicas do utilizador

limit integer opcional
offset integer opcional
Exemplo de pedido:
curl -X GET "https://api.familytreeonline.com/api/v1/trees" \ -H "Authorization: Bearer YOUR_API_KEY"
Exemplo de resposta:
{ "data": [ { "id": 1, "name": "Família Silva", "description": "Árvore genealógica 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

Criar uma nova árvore genealógica

name string obrigatório
description string opcional
Exemplo de pedido:
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 Santos", "description": "Nova árvore genealógica" }'

Membros da família

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

Obter a lista de todos os membros da família numa árvore

tree_id integer obrigatório
search string opcional
Exemplo de resposta:
{ "data": [ { "id": 1, "firstname": "João", "secondname": "Silva", "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

Adicionar um novo membro da família

firstname string obrigatório
secondname string obrigatório
birthday date opcional
gender string opcional

Relações familiares

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

Criar uma relação entre parentes

related_human_id integer obrigatório
relationship_type string obrigatório

SDKs e bibliotecas

Bibliotecas prontas para linguagens de programação populares

JavaScript/Node.js

Biblioteca oficial para JavaScript e Node.js. Suporta navegadores e ambientes de servidor.

Instalar

Python

Biblioteca Python com suporte a pedidos assíncronos. Integração fácil com Django e Flask.

Instalar

PHP

Biblioteca PHP com suporte a Composer. Compatível com Laravel e Symfony.

Instalar

Limites de pedidos

Limites para garantir um desempenho estável da API

Limites de pedidos

Tipo de conta Pedidos por minuto Pedidos por dia
Básico 60 1,000
Premium 300 10,000
Family 1,000 50,000

Perguntas frequentes

Pronto para começar a integrar?

Obtenha uma chave de API e comece a integrar o Family-Tree.Online nas suas aplicações

Criar conta Contacte-nos