ओवरव्यू

शुरुआत करें

शून्य से अपनी पहली API call तक, बस कुछ ही मिनटों में (साथ में वह समय जो हमें आपका एक्सेस मंज़ूर करने में लगता है)।

1. डेवलपर एक्सेस का अनुरोध करें#

API हर Linework यूज़र के लिए खुला है, लेकिन एक्सेस की समीक्षा हाथ से की जाती है ताकि bots उपयोगी बने रहें और स्पैम दूर रहे।

1. वेब ऐप में साइन इन करें और web.linework.app → सेटिंग्स → डेवलपर्स खोलें।
2. अनुरोध भरें:
   • Use case — आपका integration क्या करता है, कुछ वाक्यों में (उदाहरण के लिए “मेरे रेस्टोरेंट का रोज़ का मेन्यू पब्लिश करना और चैट में सवालों के जवाब देना”)।
   • वेबसाइट — आपकी साइट या प्रोजेक्ट का पेज, अगर है तो।
   • Bot का नाम — आपके ऐप या bot का नाम, जो हमें और आपकी keys की सूची में दिखाया जाता है।
3. इसे भेजें। उसी पेज पर आपको स्टेटस (pending, मंज़ूर या अस्वीकृत) दिखाई देगा।

2. एक API key बनाएँ#

एक्सेस मंज़ूर होने पर डेवलपर्स पेज पर आप API keys बना सकते हैं:

1. Key बनाएँ पर क्लिक करें, उसे एक नाम दें (उदाहरण के लिए “store-sync production”)।
2. सिर्फ़ वही scopes चुनें जिनकी integration को ज़रूरत है।
3. Key कॉपी करें। यह lwk_ के बाद 40 अक्षरों जैसी दिखती है और सिर्फ़ एक बार दिखाई जाती है।

इसे किसी environment variable या secret manager में रखें, अपने source code में कभी नहीं:

export LINEWORK_API_KEY="lwk_your_key_here"

Keys, limits और revoke करने के बारे में ज़्यादा जानकारी Authentication और API keys में है।

3. अपनी पहली call भेजें#

GET /me वह अकाउंट लौटाता है जिसकी यह key है। यह जाँचने का सबसे तेज़ तरीका है कि सब कुछ काम कर रहा है।

curl -i https://api.linework.app/open/v1/me \
  -H "Authorization: Bearer $LINEWORK_API_KEY"

const res = await fetch("https://api.linework.app/open/v1/me", {
  headers: { Authorization: `Bearer ${process.env.LINEWORK_API_KEY}` },
});
if (!res.ok) throw new Error(JSON.stringify(await res.json()));
console.log(await res.json());

import os, requests

r = requests.get(
    "https://api.linework.app/open/v1/me",
    headers={"Authorization": f"Bearer {os.environ['LINEWORK_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

सफल response एक JSON object होता है जो आपकी प्रोफ़ाइल के बारे में बताता है। अगर आपको 401 INVALID_API_KEY मिलता है, तो जाँचें कि header बिल्कुल Authorization: Bearer lwk_… है और key revoke नहीं की गई है। Response के सटीक फ़ील्ड्स API Reference में दिए गए हैं।

4. कुछ बनाइए#

लाइव होने से पहले#

• हर integration के लिए एक key इस्तेमाल करें, ताकि आप बाकियों को रोके बिना किसी एक को revoke कर सकें।
• Rate limits और दैनिक quotas का पालन करें और 429 को retry के साथ हैंडल करें।
• Errors को उनके code से हैंडल करें, मैसेज के टेक्स्ट से नहीं।
• API उपयोग की शर्तें पढ़ें।