Nyaraka za API

Jenga programu za afya juu ya API ya ClapDiet — kiolesura cha REST cha uchambuzi wa maabara, data ya vyakula, na mapendekezo ya lishe yaliyobinafsishwa.

Anza haraka

1. Omba ufikiaji

API ya ClapDiet iko katika ufikiaji mdogo na bado si ya kujihudumia: hakuna ufunguo wa kutengeneza katika mipangilio ya akaunti yako. Tuandikie nasi tutaandaa vitambulisho vyako.

2. Thibitisha ombi lako

Tuma tokeni yako katika kichwa cha Authorization kwa kila ombi. Kwa mfano:

curl -X GET https://api.clapdiet.com/api/v1/foods \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

3. Shughulikia jibu

Kila jibu ni JSON. Angalia msimbo wa hali: 200 inamaanisha mafanikio, na misimbo 400 na 500 inamaanisha kuna hitilafu.

Uthibitishaji

API ya ClapDiet hutumia tokeni za Bearer. Jumuisha yako katika kichwa cha Authorization kwa kila ombi.

Muhimu: Usishiriki tokeni yako wala kuiweka katika msimbo wa upande wa mteja ambapo wengine wanaweza kuisoma. Iweke kwenye seva yako.

Miisho ya API

POST/api/v1/auth/registerFungua akaunti mpya ya mtumiaji

POST/api/v1/auth/loginIngia na upate tokeni za ufikiaji

GET/api/v1/labsOrodhesha matokeo ya maabara ya mtumiaji

POST/api/v1/labs/uploadPakia matokeo mapya ya maabara (PDF au picha)

GET/api/v1/foodsTafuta katika hifadhidata ya vyakula

GET/api/v1/recommendationsPata mapendekezo ya vyakula yaliyobinafsishwa

Vikomo vya matumizi

Ili API ibaki haraka na ya haki kwa wote, maombi hupunguzwa katika madirisha matatu yanayopishana. Yote matatu hutumika kwa wakati mmoja.

kwa sekunde

kila sekunde 10

100

kwa dakika

Hivi ndivyo viwango vya kawaida vya huduma; mwendeshaji anaweza kuvipunguza.

Unahitaji msaada?

Timu yetu iko hapa kukusaidia kujenga na API.

Wasiliana na usaidizi