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": "Ivanov ਪਰਿਵਾਰ", "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": "Petrov ਪਰਿਵਾਰ", "description": "ਨਵਾਂ ਵੰਸ਼ ਰੁੱਖ" }'

ਪਰਿਵਾਰਕ ਮੈਂਬਰ

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

ਰੁੱਖ ਵਿੱਚ ਸਾਰੇ ਪਰਿਵਾਰਕ ਮੈਂਬਰਾਂ ਦੀ ਸੂਚੀ ਲਓ

tree_id integer ਲਾਜ਼ਮੀ
search string ਵਿਕਲਪਿਕ
ਜਵਾਬ ਦੀ ਉਦਾਹਰਣ:
{ "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

ਨਵਾਂ ਪਰਿਵਾਰਕ ਮੈਂਬਰ ਜੋੜੋ

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 ਪ੍ਰਦਰਸ਼ਨ ਲਈ ਸੀਮਾਵਾਂ

ਬੇਨਤੀ ਸੀਮਾਵਾਂ

ਖਾਤਾ ਕਿਸਮ ਪ੍ਰਤੀ ਮਿੰਟ ਬੇਨਤੀਆਂ ਪ੍ਰਤੀ ਦਿਨ ਬੇਨਤੀਆਂ
Basic 60 1,000
Premium 300 10,000
Family 1,000 50,000

ਅਕਸਰ ਪੁੱਛੇ ਜਾਣ ਵਾਲੇ ਸਵਾਲ

ਏਕੀਕਰਨ ਸ਼ੁਰੂ ਕਰਨ ਲਈ ਤਿਆਰ ਹੋ?

API ਕੁੰਜੀ ਲਓ ਅਤੇ Family-Tree.Online ਨੂੰ ਐਪਾਂ ਵਿੱਚ ਜੋੜਨਾ ਸ਼ੁਰੂ ਕਰੋ

ਖਾਤਾ ਬਣਾਓ ਸੰਪਰਕ