REST API
በCelerp በይነገጽ ውስጥ ያለ እያንዳንዱ ተግባር የREST API መዳረሻ ነው - UI በውስጡ የሚጠቀመው ያው API ነው። የሥራ ሂደቶችን በራስ-ሰር ያስኪዱ፣ ሌሎች ሥርዓቶችን ያገናኙ ወይም የራስዎን መሣሪያዎች ይገንቡ። API ከውሂብዎ ጋር በራስዎ ኮምፒውተር ላይ ይሠራል፤ ወደ ክላውድ ምንም አይላክም።
🔗 መነሻ URL
http://localhost:8000 በpip ሲጫን። የዴስክቶፕ መተግበሪያው የራሱን ፖርት ይመርጣል፤ celerp-data/api-port ን ይመልከቱ።
🔑 ማረጋገጫ
የBearer JWT ቶከን ከ/auth/login
📦 ቅርጸት
JSON ግቤት፣ JSON ውጤት
📖 ዝርዝር መግለጫ
GET /openapi.json (OpenAPI 3.1)
የትኛው ፖርት? በpip install celerp ሲጫን የAPI አገልጋዩ በlocalhost:8000 ላይ ይሰራል (በ--api-port ይቀይሩት)፤ ፖርት 8080 ደግሞ ለሰዎች የሚሆን የድር በይነገጽ ነው እንጂ API አይደለም። የዴስክቶፕ መተግበሪያው በተከፈተ ቁጥር ያልተያዙ ፖርቶችን ይመርጣል፤ የAPI ፖርቱንም በcelerp-data አቃፊው ውስጥ ባለው api-port ፋይል ላይ ይጽፋል። ፖርቱን ቋሚ ለማድረግ ከማስጀመርዎ በፊት CELERP_API_PORT ያዘጋጁ።
ማንነት ማረጋገጫ
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}ያግኙ።
ቶከኖች ፈቃዶችዎን ይይዛሉ። የviewer ቶከን ማንበብ ይችላል እንጂ መጻፍ አይችልም፤ የወጪ አሃዞችን ለማየት manager ወይም ከዚያ በላይ ሚና ያስፈልጋል። ቶከኖችን እንደ የይለፍ ቃል ይጠብቁ - ቶከኑን የያዘ ማንኛውም ሰው እርስዎን ሆኖ መሥራት ይችላል።
ጥያቄዎችን መላክ
ሁሉም የ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"
}'
ድግግሞሽን መከላከል፦ በማንኛውም የመጻፍ ጥያቄ ላይ idempotency_key ያካትቱ። በተመሳሳይ ቁልፍ እንደገና የተላከ ጥያቄ ተደጋጋሚ መዝገብ አይፈጥርም - ለሚቆራረጥ ኔትወርክ እና ለባች ሥራዎች አስተማማኝ ነው።
የአጠቃቀም ደንቦች
- ስህተቶች ከ2xx ውጭ የሆኑ ምላሾች
{"detail": "..."}ከመደበኛ የHTTP ሁኔታ ኮድ ጋር ይመልሳሉ። - የጥያቄ ገደቦች በነባሪ ለእያንዳንዱ IP በደቂቃ 60 ጥያቄዎች፤ መግቢያ በደቂቃ 10 ብቻ ነው። ገደቡን ማለፍ
429ይመልሳል። - ፈቃዶች የAPI መዳረሻዎች በሚናዎ ይወሰናሉ፦
viewer → operator → manager → admin → owner። - የኩባንያ ወሰን እያንዳንዱ ጥያቄ በቶከንዎ ውስጥ ባለው ኩባንያ ላይ ይሠራል፤ በሌላ ኩባንያ ላይ ለመሥራት ኩባንያ ይቀይሩ።
በብዛት የሚጠቀሙባቸው የAPI መዳረሻዎች
ለመጀመር የሚያግዙ ጥቂቶቹ ብቻ። እያንዳንዱ ሞጁል የራሱን መዳረሻዎች ይጨምራል - ሙሉው ዝርዝር ከታች ባለው የOpenAPI ስኪማ ውስጥ ይገኛል።
| ዘዴ | ዱካ | መግለጫ |
|---|---|---|
POST | /auth/login | የመዳረሻ ቶከን ያግኙ (ማረጋገጫ አያስፈልግም) |
GET | /health | የአገልግሎቱ ሁኔታ (ማረጋገጫ አያስፈልግም) |
GET | /items | የክምችት ዕቃዎችን ይዘርዝሩ |
POST | /items | ዕቃ ይፍጠሩ |
GET | /docs | ሰነዶችን ይዘርዝሩ (ደረሰኞች፣ የግዢ ትዕዛዞች፣ የአቅራቢ ሂሳቦች፣ …) |
POST | /docs | ሰነድ ይፍጠሩ |
GET | /crm/contacts | ደንበኞችን & አቅራቢዎችን ይዘርዝሩ |
POST | /crm/contacts | ዕውቂያ ይፍጠሩ |
GET | /dashboard/kpis | ቁልፍ የንግድ አፈጻጸም አመልካቾች (KPI) |
በየክፍሉ ሙሉ ማጣቀሻ
በሚሠራው API የሚቀርብ እያንዳንዱ የAPI መዳረሻ፣ በየክፍሉ ተደራጅቶ። እያንዳንዱ ገጽ የHTTP ዘዴውን፣ አድራሻውን፣ መለኪያዎቹን፣ የጥያቄ እና የምላሽ ቅርጸቶችን እና የምሳሌ ጥሪ ይዘረዝራል።
Auth
ለCelerp ተጠቃሚዎች ማንነት ማረጋገጥ፣ መግባት፣ መውጣት፣ የይለፍ ቃል መመለስ፣ ኩባንያ መቀየር እና API መጠቀም የሚያስችል API። (16 endpoints)
እንግሊዝኛCompanies
ለተጠቃሚዎች፣ ለሚናዎች፣ ለቦታዎች፣ ለግብሮች፣ ለክፍያ ውሎች፣ ለዋጋ ዝርዝሮች፣ ለሞጁሎችና ለኩባንያ ምርጫዎች የኩባንያ ቅንብርና አስተዳደር API። (75 endpoints)
እንግሊዝኛItems
ለምርቶች፣ ለክምችት ዕቃዎች፣ ለመጠኖች፣ ለዋጋዎች፣ ለቦታዎች፣ ለባርኮዶች፣ ለዋጋ ግምገማ፣ ለማስገባት፣ ለማስያዝ፣ ለማዘዋወር፣ ለመቀየርና ለክምችት ሁኔታ የሚያገለግል API። (38 endpoints)
እንግሊዝኛDocs
ለሽያጭ የክፍያ መጠየቂያዎች፣ ለግዢ ሂሳብ መጠየቂያዎች፣ ለግዢ ትዕዛዞች፣ ለዋጋ ጥቅሶች፣ ለክሬዲት ማስታወሻዎች፣ ለመላኪያ ሰነዶች፣ ለክፍያዎች፣ ለትዕዛዝ አፈጻጸም፣ ለPDF ውጤትና ለሰነዶች የሕይወት ዑደት አስተዳደር የሚያገለግል API። (56 endpoints)
እንግሊዝኛLists
ለክምችት ቆጠራ፣ ለዕቃ ዝውውር፣ ለኪሳራ ማስወገድ፣ ለዝርዝር ማኒፌስቶች፣ ለስካን፣ ለማስያዝ፣ ለማስታወሻዎች፣ ለመረጃ ማውጣትና ለዝርዝሮች የሕይወት ዑደት አስተዳደር የሚያገለግል API። (41 endpoints)
እንግሊዝኛAccounting
የCelerp የሂሳብ አያያዝ REST API ለሂሳብ መደቦች፣ ለዕለታዊ የሂሳብ መዝገቦች፣ ለዋና መዝገብ፣ ለባንክ ማስታረቅ፣ ለፋይናንስ መግለጫዎች፣ ለገንዘብ ዝውውሮች እና ለሂሳብ ጊዜ ገደቦች ቁጥጥር። (73 endpoints)
እንግሊዝኛLedger
የCelerp የንግድ ክስተቶችን ለማንበብና ከእነሱ የተገኘ የመተግበሪያ መረጃን እንደገና ለመገንባት የክስተት መዝገብ API። (3 endpoints)
እንግሊዝኛReports
ለደንበኞች የሚሰበሰቡና ለአቅራቢዎች የሚከፈሉ ሂሳቦች የዕድሜ ትንተና፣ ለሽያጭ፣ ለግዢና ለመጠቀሚያ ጊዜያቸው ለሚያበቃ ዕቃዎች የERP ሪፖርት API። (5 endpoints)
እንግሊዝኛManufacturing
ለምርት ትዕዛዞች፣ ለአሠራር ቀመሮች፣ ለሥራ ማዕከሎች፣ ለሥራ ፍሰቶች፣ ለግብዓት ፍላጎት፣ ለወጪ ስሌት፣ ለጊዜ ሰሌዳ፣ ለክፍሎች ወጪ ማድረግና ለተጠናቀቁ ምርቶች መቀበል የማምረቻ API። (32 endpoints)
እንግሊዝኛLabels
ለዕቃ መለያ ንድፎች፣ ለነጠላ ዕቃ መለያዎች፣ ለብዛት መለያ ወረቀቶችና ለማተም የሚቻሉ PDF ፋይሎች የዕቃ መለያና ባርኮድ API። (10 endpoints)
እንግሊዝኛCrm
ለደንበኞች፣ ለአቅራቢዎች፣ ለእውቂያዎች፣ ለአድራሻዎች፣ ለግለሰቦች፣ ለማስታወሻዎች፣ ለመለያዎች፣ ለፋይሎች፣ ለመረጃ ማስገባትና ማውጣት እንዲሁም ለእውቂያ አስተዳደር የCRM REST API። (25 endpoints)
እንግሊዝኛSubscriptions
ለተደጋጋሚ የክፍያ መጠየቂያዎችና ምዝገባዎች፣ ለየክፍያ መጠየቂያና ለግዢ ትዕዛዝ ንድፎች፣ ለጊዜ ሰሌዳ፣ ለማስጀመር፣ ለማቆም፣ ለመቀጠል፣ ለመሰረዝና በጥያቄ ጊዜ ለመፍጠር የሚያገለግል API። (22 endpoints)
እንግሊዝኛConnectors
Celerp ERPን ከውጭ የንግድ መድረኮች ጋር ለማገናኘት፣ የአገናኞችን የመግቢያ መረጃ ለማስተዳደርና መረጃ ለማመሳሰል የሚያገለግል API። (18 endpoints)
እንግሊዝኛPayments
የክፍያ ሂደትን ለማገናኘት፣ የክፍያ አገልግሎት መኖሩን ለማረጋገጥና የግንኙነት ሁኔታን ለማየት የክፍያ ውህደት API። (7 endpoints)
እንግሊዝኛBackup
የCelerp ERP የመጠባበቂያ ቅጂዎችን ለመላክ፣ ለማስገባት፣ ለመዘርዘር፣ ለመፍጠርና መልሶ ለማግኘት የሚያገለግል API። (8 endpoints)
እንግሊዝኛNotifications
የተጠቃሚ ማሳወቂያዎችን ለመዘርዘርና አንዱን ወይም ሁሉንም እንደተነበቡ ለማመልከት የማሳወቂያ API። (3 endpoints)
እንግሊዝኛEvents
ለCelerp ማሳወቂያዎችና ለቀጥታ የመተግበሪያ ክስተቶች የአገልጋይ ቀጥታ ክስተት ማስተላለፊያ (SSE) API። (1 endpoint)
እንግሊዝኛSystem
ለCelerp ERP ጭነት የስርዓት ጤና፣ ዝግጁነት፣ እንደገና ማስጀመርና ወደ ፋብሪካ ቅንብር መመለስ መገናኛዎች። (10 endpoints)
እንግሊዝኛAdmin
የCelerp ERP ጭነትን ለመጠገን የአስተዳደር ምርመራና የስርዓት ሁኔታ መፈተሻ መገናኛዎች። (2 endpoints)
እንግሊዝኛAi
የCelerp AI API ለERP ረዳት ውይይቶች፣ ከሰነዶች መረጃ ማውጣት፣ ለቡድን ሥራዎች፣ ለማስታወሻ፣ ለአጠቃቀም መረጃ እና ተጠቃሚው ለሚያረጋግጣቸው የንግድ እርምጃዎች። (26 endpoints)
እንግሊዝኛAttachments
የዕቃ ክምችት አባሪ ፋይሎችና የምርት ምስሎች ለመስቀል፣ ለማውረድ፣ መለያ ለመስጠት፣ ቅድመ እይታ ለማሳየትና ለመሰረዝ የሚያገለግል API። (12 endpoints)
እንግሊዝኛDashboard
የERP ዋና የአፈጻጸም መለኪያዎችን፣ የቅርብ ጊዜ የንግድ እንቅስቃሴዎችንና ሊፈለግ የሚችል የእንቅስቃሴ ታሪክ የሚያሳይ የዳሽቦርድ API። (3 endpoints)
እንግሊዝኛPayments Public
ለደንበኞች የክፍያ አገናኞችና ከክፍያ አቅራቢዎች የሚመለሱ ሂደቶች የሕዝብ ክፍያ መገናኛዎች። (2 endpoints)
እንግሊዝኛReceived
ሌሎች የCelerp ተጠቃሚዎች ያጋሯቸውን የተቀበሉ ሰነዶች ለመዘርዘርና ለመገምገም፣ አንዱን እንደ የራስዎ ረቂቅ ለመመዝገብ፣ ከዚያም ረቂቁን በላኪው የቅርብ ጊዜ ማሻሻያ መሠረት ለማዘመን የሚያገለግል API። (5 endpoints)
እንግሊዝኛSearch
በአንድ ፍለጋ በተለያዩ ሞጁሎች ውስጥ ለመድረስ ፈቃድ ያላቸውን መዝገቦች ለማግኘት የCelerp ERP አጠቃላይ ፍለጋ API። (1 endpoint)
እንግሊዝኛSettings
ለመለያ ዝግጅት፣ ለደመና ግንኙነት ሁኔታ፣ ለክፍያ መጠየቅ፣ ለመጠባበቂያ ቅጂዎች፣ ለአገናኞችና ለአጋር ቅንብሮች የስርዓት ቅንብርና Celerp Connect API። (18 endpoints)
እንግሊዝኛShare
ለCelerp ሰነዶችና ዝርዝሮች የሕዝብ ማጋሪያ አገናኞችን ለመፍጠር፣ ለማየት፣ ለማዘመንና ለመሻር የሰነድ ማጋሪያ API። (4 endpoints)
እንግሊዝኛShare Public
የተጋሩ የCelerp ሰነዶችን ለማየትና ሊተላለፉ የሚችሉ የሰነድ ጥቅሎችን ለማውረድ ወይም ለማስገባት የሕዝብ ማጋሪያና ማስገቢያ መገናኛዎች። (4 endpoints)
እንግሊዝኛStars
የCelerp ደጋፊ ባጆችን ለማረጋገጥ፣ ለማሳየት፣ ከተሳትፎ ለመውጣትና የማበረታቻ መልዕክቶችን ለማሳየት የማኅበረሰብ እውቅና API። (6 endpoints)
እንግሊዝኛVerticals
የCelerp ERP መስኮችንና መነሻ እሴቶችን በንግድ ዘርፍ መሠረት ለማቀናበር የዘርፍ ነባሪ ቅንብሮችና የምድብ መዋቅር API። (5 endpoints)
እንግሊዝኛCompany Backups
27 endpoints
እንግሊዝኛCompany Peers
5 endpoints
እንግሊዝኛFixed Assets
117 endpoints
እንግሊዝኛHelp
3 endpoints
እንግሊዝኛMigrations
39 endpoints
እንግሊዝኛሙሉውን API ይመልከቱ
ሙሉ እና ሁልጊዜ የተዘመነው ማጣቀሻ የራስዎ Celerp የሚያመነጨው የOpenAPI 3.1 ስኪማ ነው፦
GET http://localhost:8000/openapi.json
ወደ ማንኛውም የOpenAPI መሣሪያ - Postman፣ Insomnia፣ Swagger UI ወይም የኮድ ማመንጫ - ያስገቡት፤ እያንዳንዱን የAPI መዳረሻ እና የውሂብ ሞዴል ይመልከቱ፣ ጥያቄዎችን ይሞክሩ፣ በሚጠቀሙበት የፕሮግራም ቋንቋ ዝግጁ የAPI ደንበኛ ኮድ ያመንጩ። Celerp በኢንተርኔት የሚስተናገድ የሰነድ ገጽ ሳይሆን ስኪማውን ራሱን ያቀርባል፤ ስለዚህ የAPIዎ ዝርዝር በራስዎ Celerp ውስጥ ብቻ በግል ይቆያል።
በቀላል ቋንቋ መጠየቅ ይመርጣሉ? የAI ረዳቱ (Connect) ይህንኑ API ለእርስዎ ይጠቀማል - ሪፖርት እንዲያወጣ ወይም ሰነድ እንዲፈጥር በተለመደው ቋንቋ ይጠይቁት። ያስታውሱ፦ API ማድረግ የሚችለውን ሁሉ ያለ ምንም ልዩ ፈቃድ ነው የሚያደርገው - በትክክል የገባ ተጠቃሚ ማድረግ የሚችለውን ብቻ።