एपीआई दस्तावेज़ीकरण

श्रेणियाँ:

श्रेणियाँ:

Shifton API से कनेक्ट करना और कार्य करना

Shifton API आपको प्लेटफॉर्म की सभी प्रमुख विशेषताओं तक पहुँच प्रदान करता है — शेड्यूल प्रबंधन से लेकर बाहरी एचआर, पेरोल और एनालिटिक्स सिस्टम के साथ इंटीग्रेशन तक।.
एपीआई का उपयोग करके, आप प्रक्रियाओं को स्वचालित कर सकते हैं और Shifton को अपनी कंपनी की आंतरिक सेवाओं से जोड़ सकते हैं।


API प्रलेखन

हम अपने प्रलेखन के दो संस्करणों का समर्थन करते हैं:


प्रारंभ करें

API कुंजी प्राप्त करें

Shifton प्लेटफ़ॉर्म पर अपनी कंपनी की सेटिंग में, एक API की.
बनाएँ। प्राधिकरण हेडर के माध्यम से किया जाता है:

Authorization: Bearer {your_api_key}

अपनी पहली अनुरोध करें

उदाहरण के लिए, कर्मचारियों की सूची प्राप्त करने के लिए:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

उदाहरण प्रतिक्रिया:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

एपीआई को अपने वर्कफ्लो में एकीकृत करें

  • स्वचालित रूप से शिफ्ट्स बनाएं और संशोधित करें

  • अवकाश और बीमार छुट्टी अनुरोधों का प्रबंधन करें

  • पेरोल सिस्टम के लिए डेटा निर्यात करें

  • अनुकूलित डैशबोर्ड और रिपोर्ट बनाएं


कोर एपीआई क्षमताएँ

  • कर्मचारी – जोड़ें, संपादित करें, और भूमिकाओं का प्रबंधन करें

  • अनुसूची – शिफ्ट बनाएं, समायोजित करें, काम की योजना बनाएं

  • कार्य से अनुपस्थिति एवं छुट्टियाँ – अवकाश और बीमार छुट्टी के अनुरोधों का प्रबंधन करें

  • रिपोर्टिंग – समय, वेतन, और उपस्थिति डेटा निर्यात करें


त्रुटि कोड

Shifton एपीआई मानक HTTP स्थिति कोड:

  • 200 — सफल अनुरोध

  • 201 — वस्तु सफलतापूर्वक बनाई गई

  • 400 — अमान्य पैरामीटर

  • 401 — प्राधिकरण त्रुटि (अमान्य एपीआई कुंजी)

  • 403 — प्रवेश निषेध

  • 404 — संसाधन नहीं मिला

  • 500 — सर्वर त्रुटि


उपयोग सुझाव

  • हमेशा नई एपीआई संस्करण का उपयोग करें नई एकीकरणों के लिए

  • का उपयोग करें पोस्टमैन या कर्ल का उपयोग परीक्षण के लिए करें

  • दर सीमा का सम्मान करें ताकि ब्लॉक होने से बचा जा सके

  • उन एकीकरणों को अद्यतन करें जो अभी भी पुराने प्रलेखन पर निर्भर हैं


इस पोस्ट को साझा करें