REST API

በCelerp በይነገጽ ውስጥ ያለ እያንዳንዱ ተግባር የREST API መዳረሻ ነው - UI በውስጡ የሚጠቀመው ያው API ነው። የሥራ ሂደቶችን በራስ-ሰር ያስኪዱ፣ ሌሎች ሥርዓቶችን ያገናኙ ወይም የራስዎን መሣሪያዎች ይገንቡ። API ከውሂብዎ ጋር በራስዎ ኮምፒውተር ላይ ይሠራል፤ ወደ ክላውድ ምንም አይላክም።

ማንነት ማረጋገጫ

Celerp ለአጭር ጊዜ የሚያገለግሉ የJSON ዌብ ቶከኖችን ይጠቀማል። የመዳረሻ ቶከን ለማግኘት በCelerp ኢሜይልዎ እና የይለፍ ቃልዎ ይግቡ፤ ከዚያም በእያንዳንዱ ጥያቄ ላይ እንደ Bearer ራስጌ ይላኩት።

1. ይግቡ

curl -X POST http://localhost:8000/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "your-password"}'

ምላሹ ሁለት ቶከኖችን ይይዛል፦

{
  "access_token": "eyJhbGciOiJI...",
  "refresh_token": "eyJhbGciOiJI..."
}

2. በቶከኑ API ይጥሩ

curl http://localhost:8000/items \
  -H "Authorization: Bearer eyJhbGciOiJI..."

• ቶከኑ ተጠቃሚዎን፣ ሚናዎን እና ኩባንያዎን ይለያል፤ ስለዚህ ጥያቄዎች በራስ-ሰር በዚያ ኩባንያ ብቻ ይወሰናሉ - ተጨማሪ ራስጌ አያስፈልግም።
• የመዳረሻ ቶከኖች እስከ 24 ሰዓት ያገለግላሉ። አንዱ ጊዜው ሲያልፍ refresh_token በPOST ወደ /auth/token/refresh በመላክ አዲስ ጥንድ ቶከን ያግኙ።
• ከአንድ በላይ ኩባንያ አባል ነዎት? በGET /auth/my-companies ይዘርዝሯቸው፤ ከዚያም ለሌላው ኩባንያ የሚያገለግል ቶከን በPOST /auth/switch-company/{company_id} ያግኙ።

ጥያቄዎችን መላክ

ሁሉም የAPI መዳረሻዎች በAPI ሰርቨርዎ አድራሻ ሥር ይገኛሉ (በpip ሲጫን http://localhost:8000፣ ከታች ባሉት ምሳሌዎች እንዳለው) እና JSON ይመልሳሉ። የዝርዝር መዳረሻዎች የitems ድርድር እና የtotal ብዛት ይመልሳሉ፦

curl "http://localhost:8000/items?limit=20&offset=0" \
  -H "Authorization: Bearer $TOKEN"

{
  "items": [
    { "id": "item:...", "sku": "WIDGET-001", "name": "Widget", "quantity": 42 }
  ],
  "total": 142
}

ገጽ በገጽ ማሳየት፦ ?limit= (ነባሪው 50) እና ?offset= ይላኩ። አብዛኞቹ የዝርዝር መዳረሻዎች የq= የፍለጋ ቃል እና የአምድ ማጣሪያዎችንም ይቀበላሉ (ለምሳሌ ?status=available)።

ውሂብ መፍጠር

መዝገቦችን ለመፍጠር JSON በPOST ይላኩ። የመጻፍ ጥያቄዎች የአዲሱን መዝገብ id ይመልሳሉ (ከጀርባው ያለውንም event_id - በCelerp ውስጥ እያንዳንዱ ለውጥ እንደ ክስተት ይመዘገባል)።

curl -X POST http://localhost:8000/crm/contacts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "[email protected]",
    "contact_type": "customer",
    "idempotency_key": "acme-2026-06-21"
  }'

የአጠቃቀም ደንቦች

• ስህተቶች ከ2xx ውጭ የሆኑ ምላሾች {"detail": "..."} ከመደበኛ የHTTP ሁኔታ ኮድ ጋር ይመልሳሉ።
• የጥያቄ ገደቦች በነባሪ ለእያንዳንዱ IP በደቂቃ 60 ጥያቄዎች፤ መግቢያ በደቂቃ 10 ብቻ ነው። ገደቡን ማለፍ 429 ይመልሳል።
• ፈቃዶች የAPI መዳረሻዎች በሚናዎ ይወሰናሉ፦ viewer → operator → manager → admin → owner።
• የኩባንያ ወሰን እያንዳንዱ ጥያቄ በቶከንዎ ውስጥ ባለው ኩባንያ ላይ ይሠራል፤ በሌላ ኩባንያ ላይ ለመሥራት ኩባንያ ይቀይሩ።

በብዛት የሚጠቀሙባቸው የAPI መዳረሻዎች

ለመጀመር የሚያግዙ ጥቂቶቹ ብቻ። እያንዳንዱ ሞጁል የራሱን መዳረሻዎች ይጨምራል - ሙሉው ዝርዝር ከታች ባለው የOpenAPI ስኪማ ውስጥ ይገኛል።

በየክፍሉ ሙሉ ማጣቀሻ

በሚሠራው API የሚቀርብ እያንዳንዱ የAPI መዳረሻ፣ በየክፍሉ ተደራጅቶ። እያንዳንዱ ገጽ የHTTP ዘዴውን፣ አድራሻውን፣ መለኪያዎቹን፣ የጥያቄ እና የምላሽ ቅርጸቶችን እና የምሳሌ ጥሪ ይዘረዝራል።

ሙሉውን API ይመልከቱ

ሙሉ እና ሁልጊዜ የተዘመነው ማጣቀሻ የራስዎ Celerp የሚያመነጨው የOpenAPI 3.1 ስኪማ ነው፦

GET http://localhost:8000/openapi.json

ወደ ማንኛውም የOpenAPI መሣሪያ - Postman፣ Insomnia፣ Swagger UI ወይም የኮድ ማመንጫ - ያስገቡት፤ እያንዳንዱን የAPI መዳረሻ እና የውሂብ ሞዴል ይመልከቱ፣ ጥያቄዎችን ይሞክሩ፣ በሚጠቀሙበት የፕሮግራም ቋንቋ ዝግጁ የAPI ደንበኛ ኮድ ያመንጩ። Celerp በኢንተርኔት የሚስተናገድ የሰነድ ገጽ ሳይሆን ስኪማውን ራሱን ያቀርባል፤ ስለዚህ የAPIዎ ዝርዝር በራስዎ Celerp ውስጥ ብቻ በግል ይቆያል።