ओवरव्यू

Authentication और API keys

हर request एक पर्सनल API key से authenticate होती है, जिसे Bearer token के रूप में भेजा जाता है।

Key भेजना#

हर request में Authorization header जोड़ें:

GET /open/v1/me HTTP/1.1
Host: api.linework.app
Authorization: Bearer lwk_aBcD1234...

सभी requests HTTPS पर होनी चाहिए। Query string या body में भेजी गई keys स्वीकार नहीं की जातीं।

प्रॉपर्टी	विवरण
फ़ॉर्मैट	`lwk_` + 40 अक्षर और अंक
मालिक	वह Linework अकाउंट जिसने इसे बनाया है। हर action उसी अकाउंट के रूप में होता है।
Permissions	Key बनाते समय चुने गए scopes। इन्हें बाद में बदला नहीं जा सकता: इसके बजाय नई key बनाएँ।
दृश्यता	बनाते समय सिर्फ़ एक बार दिखाई जाती है। Linework केवल उसका hash सेव करता है और उसे दोबारा नहीं दिखा सकता।
सीमा	हर अकाउंट पर अधिकतम 5 सक्रिय keys।
समाप्ति	Keys expire नहीं होतीं। वे तब काम करना बंद करती हैं जब आप उन्हें revoke करते हैं या जब डेवलपर एक्सेस revoke हो जाता है।

एक key बनाएँ, उसे नाम दें और scopes चुनें।
एक key revoke करें: वह तुरंत काम करना बंद कर देती है, और इसे वापस नहीं लिया जा सकता। Revoke की गई keys 5 keys की सीमा में नहीं गिनी जातीं।
देखें कि हर key आख़िरी बार कब इस्तेमाल हुई, ताकि आप उन keys को पहचान सकें जिनकी अब ज़रूरत नहीं है।

Keys अपने सर्वर पर रखें। किसी key को मोबाइल ऐप, ब्राउज़र पेज, पब्लिक repository या सपोर्ट मैसेज में कभी न डालें।
हर key को सिर्फ़ उतने ही scopes दें जितने उसे चाहिए, और हर integration के लिए एक अलग key इस्तेमाल करें।
अगर कोई key लीक हो जाए, तो उसे तुरंत revoke करें और नई key बनाएँ। Linework स्टाफ़ आपसे कभी आपकी key नहीं माँगेगा।

Status	Code	मतलब
401	`INVALID_API_KEY`	Header मौजूद नहीं है, key ग़लत है, या उसे revoke कर दिया गया है।
403	`INSUFFICIENT_SCOPE`	Key वैध है, लेकिन उसके पास वह scope नहीं है जो इस endpoint को चाहिए।
403	`DEVELOPER_ACCESS_REVOKED`	अकाउंट का डेवलपर एक्सेस निलंबित या revoke कर दिया गया है। उसकी सभी keys काम करना बंद कर देती हैं।
403	`PROFILE_INCOMPLETE`	Write endpoints के लिए ऐसा अकाउंट चाहिए जिसमें प्रोफ़ाइल फ़ोटो और कवर हो।

सभी codes Errors में देखें।