API संदर्भ गाइड

शुरुआत करें

API से शुरुआत करने के लिए हम API परीक्षण टूल का उपयोग करने का सुझाव देते हैं। प्रोग्रामिंग शुरू करने से पहले API अनुरोधों को आज़माने और अपना वर्कफ़्लो ठीक करने के लिए Bruno और Postman दोनों बढ़िया हैं।

Bruno के साथ शुरुआत

शुरू करने के लिए आपको Bruno डाउनलोड और इंस्टॉल करना होगा। प्रोग्रामिंग शुरू करने से पहले API अनुरोधों को आज़माने और अपना वर्कफ़्लो ठीक करने के लिए Bruno एक बढ़िया ओपन सोर्स टूल है।

हमारे सभी एंडपॉइंट और पैरामीटर जोड़ने के लिए यह फ़ाइल डाउनलोड करके हमारा Bruno संग्रह इंपोर्ट करें।
संग्रह को Bruno में इंपोर्ट करें
प्रमाणीकरण API कुंजी से होता है, इसके लिए अनुरोध हेडर "apiKey" जोड़ें।
Bruno में API कुंजी कैसे जोड़ें
API कुंजी यहाँ बनाई जा सकती है: पोर्टल सेटिंग्स API

Postman के साथ शुरुआत

शुरू करने के लिए आपको Postman डाउनलोड और इंस्टॉल करना होगा। प्रोग्रामिंग शुरू करने से पहले API अनुरोधों को आज़माने और अपना वर्कफ़्लो ठीक करने के लिए Postman एक बढ़िया टूल है।

हमारे सभी एंडपॉइंट और पैरामीटर जोड़ने के लिए यह लिंक कॉपी करके हमारा Postman संग्रह इंपोर्ट करें।
संग्रह को Postman में इंपोर्ट करें
प्रमाणीकरण API कुंजी से होता है, इसके लिए अनुरोध हेडर "apiKey" जोड़ें।
Postman में API कुंजी कैसे जोड़ें
API कुंजी यहाँ बनाई जा सकती है: पोर्टल सेटिंग्स API

संदर्भ

समूह प्राप्त करें

समूह ऑब्जेक्ट की जानकारी लौटाता है। सभी समूह लौटाएगा।

उदाहरण क्वेरी

GET https://timeclock.kiwi/api/groups

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

[
    {
        "id": "d2358de1-3631-428a-a314-f1bdb8ab53a2",
        "name": "Auckland",
        "deleted": false,
        "last_updated": "2024-06-06T21:19:17.622Z",
        "created": "2024-06-06T21:19:17.622Z"
    },
    {
        "id": "369b6e85-b90f-4262-9fab-08da623fe3bd",
        "name": "Christchurch",
        "deleted": false,
        "last_updated": "2024-08-12T20:00:36.701Z",
        "created": "2024-08-12T20:00:36.701Z"
    }
]

काम प्राप्त करें

काम ऑब्जेक्ट की जानकारी लौटाता है। डिफ़ॉल्ट रूप से सभी काम लौटाएगा।

Parameters

PropertyDescriptionTypeRequirementDefault
idID देने पर वही विशेष काम लौटाया जाएगा। यह मान न देने पर सभी काम लौटाए जाएँगे।UUIDOptional
completedकेवल वे काम लौटाता है जिनका completed फ़ील्ड मान से मेल खाता है।BooleanOptionalfalse
deletedकेवल वे काम लौटाता है जिनका deleted फ़ील्ड मान से मेल खाता है।BooleanOptionalfalse

Example Query

GET https://timeclock.kiwi/api/jobs?id=01d2aa95-1866-4718-8d86-08aa5182f20d&completed=true&deleted=true

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

[
    {
        "id": "055fdff9-c264-4c5d-a98e-e98bab581d1a",
        "name": "63 Handover Rd",
        "description": "",
        "cost_code": null,
        "due_date": null,
        "completed": false,
        "permanent": false,
        "deleted": false,
        "budget_hours": 120,
        "priority": false,
        "last_updated": "2024-11-01T02:22:56.973Z",
        "created": "2024-11-01T02:22:56.973Z",
        "groups": [
            {
                "id": "f8a97df7-85b9-4331-a284-9463c68810b8",
                "name": "Mosgiel"
            }
        ],
        "people": null
    },
]

काम जोड़ें

एक काम ऑब्जेक्ट जोड़ता है।

Body

PropertyDescriptionTypeRequirementDefault
nameजॉब का नाम।StringRequired
descriptionजॉब का विवरण।StringOptional
permanentक्या इस जॉब को पूरा चिह्नित किया जा सकता है?BooleanOptionalfalse
due_dateवह तारीख जब तक जॉब पूरा होना है।Stringpermanent == false होने पर ज़रूरी
cost_codeजॉब का कॉस्ट कोड।StringOptional
completedक्या यह जॉब पूरा हो गया है?BooleanOptionalfalse
deletedक्या यह जॉब हटा दिया गया है?BooleanOptionalfalse
budget_hoursजॉब के लिए बजट (कोटेशन) किए गए श्रम घंटे। बजट न हो तो null।NumberOptionalnull
priorityक्या यह प्राथमिक जॉब है? प्राथमिक जॉब कियोस्क पर पहले दिखते हैं।BooleanOptionalfalse

Example Query

POST https://timeclock.kiwi/api/jobs
{
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": false,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "budget_hours": 120,
    "priority": false,
    "completed": false,
    "deleted": false
}

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

{
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": false,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "budget_hours": 120,
    "priority": false,
    "completed": false,
    "deleted": false,
    "id": "b6dac400-5097-4763-8021-137222cb1ad4"
}

काम हटाएँ

सूचीबद्ध काम ऑब्जेक्ट हटाता है।

बॉडी

प्रॉपर्टीविवरणप्रकारआवश्यकताडिफ़ॉल्ट
UUIDहटाए जाने वाले सभी कामों के UUID की सूची।UUIDआवश्यक

Example Query

DELETE https://timeclock.kiwi/api/jobs
["01d2aa95-1866-4718-8d86-08aa5182f20d", "13074d81-2483-46ea-8bce-b8d761c2580e"]

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

{
    "status": 200
}

काम अपडेट करें

एक काम ऑब्जेक्ट अपडेट करता है।

बॉडी

प्रॉपर्टीविवरणप्रकारआवश्यकताडिफ़ॉल्ट
idउस काम का UUID जिसे आप बदलना चाहते हैं।UUIDआवश्यक
nameकाम का नाम।Stringआवश्यक
descriptionकाम का विवरण।Stringवैकल्पिक
permanentक्या यह ऐसा काम है जिसे पूर्ण चिह्नित किया जा सकता है?Booleanवैकल्पिकfalse
due_dateवह तारीख़ जब तक काम पूरा होना है।Stringpermanent == false होने पर आवश्यक
cost_codeकाम का लागत कोड।Stringवैकल्पिक
completedक्या यह काम पूरा हो चुका है?Booleanवैकल्पिकfalse
deletedक्या यह काम हटाया जा चुका है?Booleanवैकल्पिकfalse
budget_hoursजॉब के लिए बजट (कोटेशन) किए गए श्रम घंटे। बजट न हो तो null।Numberवैकल्पिकnull
priorityक्या यह प्राथमिक जॉब है? प्राथमिक जॉब कियोस्क पर पहले दिखते हैं।Booleanवैकल्पिकfalse
groupsउन सभी समूहों के UUID जिनका यह काम हिस्सा है।UUIDवैकल्पिक
peopleउन सभी लोगों के UUID जिन्हें यह काम दिखाई देगा।UUIDवैकल्पिक
materialsइस काम में उपयोग की गई सभी सामग्री की सूची। सामग्री किसी व्यक्ति द्वारा उपयोग की गई होनी चाहिए।UUIDवैकल्पिक
notesकाम में एक नया नोट जोड़ता है।UUIDवैकल्पिक

Example Query

PUT https://timeclock.kiwi/api/jobs
{
    "id": "dfb37a1e-692e-44d5-bedf-309b44b9e136",
    "name": "99 Bamford St",
    "description": "Renovating kitchen in 6 apartments",
    "permanent": true,
    "due_date": "2024-11-30 09:00",
    "cost_code": "123456",
    "completed": true,
    "deleted": true,
    "groups": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],
    "people": ["d2358de1-3631-428a-a314-f1bdb8ab53a2","d2358de1-3631-428a-a314-f1bdb8ab53a3"],
    "materials": [{ "id": "03b133a9-4546-4e73-89c8-119fb5042fdb", "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "quantity": 5}],
    "notes": [{ "person_id": "017a1008-de92-4df2-a533-4e17b643123e", "note": "Concrete has cat paw prints on it."}]
}

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

{
    "status": 200
}

कियोस्क प्राप्त करें

कियोस्क ऑब्जेक्ट की जानकारी लौटाता है। सभी कियोस्क लौटाएगा।

उदाहरण क्वेरी

GET https://timeclock.kiwi/api/kiosks

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

[
    {
        "id": "353e1f09-9851-42c8-9b2c-e536ce2cd3bb",
        "name": "Back Stairs",
        "deleted": false,
        "status": "Offline",
        "last_updated": "2024-06-10T00:09:43.169Z",
        "created": "2024-06-10T00:09:43.169Z"
    },
    {
        "id": "7276d2e1-0fe2-4b64-8d89-1e9b65f4a969",
        "name": "Factory Front",
        "deleted": false,
        "status": "Offline",
        "last_updated": "2024-06-10T02:22:51.027Z",
        "created": "2024-06-10T02:22:51.027Z"
    }
]

सामग्री प्राप्त करें

सामग्री ऑब्जेक्ट की जानकारी लौटाता है। सभी सामग्री लौटाएगा।

उदाहरण क्वेरी

GET https://timeclock.kiwi/api/materials

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

[
    {
        "id": "03b133a9-4546-4e73-89c8-119fb5042fdb",
        "name": "M2 Screw",
        "cost_code": "0001",
        "unit": "none",
        "description": "2mm thick screw",
        "last_updated": "2024-08-19T21:42:33.021Z",
        "created": "2024-08-19T21:42:33.021Z"
    },
    {
        "id": "c127106f-0570-485c-9466-dcf543d9ffbd",
        "name": "MDF18",
        "cost_code": "ABC123",
        "unit": "m²",
        "description": "18mm MDF",
        "last_updated": "2024-08-05T03:08:12.870Z",
        "created": "2024-08-05T03:08:12.870Z"
    }
]

लोग प्राप्त करें

लोग ऑब्जेक्ट की जानकारी लौटाता है। सभी लोग लौटाएगा।

उदाहरण क्वेरी

GET https://timeclock.kiwi/api/people

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

[
    {
        "id": "b6cc9e4b-cccb-4206-92a0-a387ff121c69",
        "first_name": "Aspen",
        "last_name": "Brewster",
        "email": "[email protected]",
        "pin_enabled": false,
        "pin": null,
        "permission": 3,
        "last_updated": "2024-09-09T02:44:06.604Z",
        "created": "2024-09-09T02:44:06.604Z"
    },
    {
        "id": "2d68300b-f34e-45f9-a1a5-fdf0daa59729",
        "first_name": "Bryne",
        "last_name": "Lynton",
        "email": null,
        "pin_enabled": false,
        "pin": null,
        "permission": 3,
        "last_updated": "2024-09-09T02:44:06.604Z",
        "created": "2024-09-09T02:44:06.604Z"
    }
]

शिफ्ट प्राप्त करें

शिफ्ट ऑब्जेक्ट की जानकारी लौटाता है।

पैरामीटर

प्रॉपर्टीविवरणप्रकारआवश्यकताडिफ़ॉल्ट
start-dateलौटाई जाने वाली शिफ्टों का पहला दिन (सहित)।ISO 8601 तारीख़ (YYYY-MM-DD)आवश्यक
end-dateलौटाई जाने वाली शिफ्टों का अंतिम दिन (सहित)।ISO 8601 तारीख़ (YYYY-MM-DD)आवश्यक
group-idकेवल इस समूह के लोगों की शिफ्टें लौटाता है।UUIDवैकल्पिक
person-idकेवल इस व्यक्ति की शिफ्टें लौटाता है।UUIDवैकल्पिक

Example Query

GET https://timeclock.kiwi/api/shifts?start-date=2026-02-20&end-date=2026-02-27&group-id=752d68b5-5d57-4727-8c1c-85383b76fecf&person-id=a8b3e429-d307-4cd1-bde4-1c2510b6b8ef

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

[
  {
    "person_id": "a8b3e429-d307-4cg1-bde4-1c2510b8b8ef",
    "first_name": "Ada",
    "last_name": "Nicodemou",
    "days": [
      {
        "date": "2026-02-20",
        "total_hours": 6.82,
        "hours_worked": 6.57,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-21",
        "total_hours": 6.98,
        "hours_worked": 6.73,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-22",
        "total_hours": 7.02,
        "hours_worked": 6.77,
        "break_hours": 0.25
      }
    ]
  },
  {
    "person_id": "b1d8859f-84cc-49c0-ba94-175c8a1e16c4",
    "first_name": "Fred",
    "last_name": "Flinstone",
    "days": [
      {
        "date": "2026-02-20",
        "total_hours": 8.12,
        "hours_worked": 7.95,
        "break_hours": 0.17
      },
      {
        "date": "2026-02-21",
        "total_hours": 8.13,
        "hours_worked": 7.88,
        "break_hours": 0.25
      },
      {
        "date": "2026-02-22",
        "total_hours": 1.97,
        "hours_worked": 1.72,
        "break_hours": 0.25
      }
    ]
  }
]

हम हमेशा मदद के लिए तैयार हैं।
हमसे संपर्क करें, हम पूरी कोशिश करेंगे कि हमारा कर्मचारी उपस्थिति सिस्टम आपके लिए काम करे।