API दस्तावेज़
v2 API से Kick प्राधिकरण प्रवाह बनाएँ, अनुमतियाँ देखें और टोकन प्रबंधित करें।
प्राधिकरण प्रवाह
- अनुमति सूची देखें और अपने एकीकरण के लिए आवश्यक सक्रिय अनुमतियों के ID चुनें।
- प्रवाह बनाएँ। उसकी प्राप्ति कुंजी निजी रखें और खाते के मालिक के ब्राउज़र में authorization_url खोलें।
- प्राधिकरण के बाद क्रेडेंशियल एक बार प्राप्त करें। एक्सेस टोकन और नवीनतम रिफ्रेश टोकन दोनों सहेजें।
प्रवाह 24 घंटे बाद समाप्त होते हैं। सफल प्राप्ति के बाद संग्रहीत क्रेडेंशियल दोबारा प्राप्त नहीं किए जा सकते। लंबित प्राधिकरण की जाँचों के बीच कम से कम पाँच सेकंड रुकें।
प्रमाणीकरण और सीमाएँ
क्रेडेंशियल प्राप्त करने के लिए प्रवाह की निजी कुंजी को Bearer क्रेडेंशियल की तरह उपयोग करें। अन्य एंडपॉइंट नीचे दिए इनपुट लेते हैं। v2 API प्रति IP प्रति मिनट 120 अनुरोध स्वीकार करती है; HTTP 429 का अर्थ सीमा पूरी होना है।
एंडपॉइंट संदर्भ
GET /api/v2/scopes
उपलब्ध टोकन अनुमतियाँ
मौजूदा अनुमति ID, नाम, विवरण और उपलब्धता देखें। इस अनुरोध के लिए क्रेडेंशियल आवश्यक नहीं हैं।
इस एंडपॉइंट में अनुरोध पैरामीटर नहीं हैं।
प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "scopes": [ { "description": "Send chat messages as the authorized account.", "id": 6, "scope": "chat:write", "secret": false } ], "success": true } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/workflows
प्राधिकरण प्रवाह बनाएँ
24 घंटे का अनुमति वर्कफ़्लो बनाएँ। सक्षम साझा मोड इस्तेमाल करें या POST बॉडी में अपने ऐप के क्रेडेंशियल दें।
पैरामीटर
ai_agentवैकल्पिकstring· बॉडीवैकल्पिक AI क्लाइंट नाम, नियंत्रण अक्षरों के बिना अधिकतम 64 UTF-8 बाइट। यह स्रोत पहचानने के लिए है, प्रमाणीकरण के लिए नहीं।
credentialsवैकल्पिकobject· बॉडीअपना Kick डेवलपर ऐप इस्तेमाल करें। दोनों फ़ील्ड केवल साझा मोड उपलब्ध होने पर खाली छोड़ें। क्रेडेंशियल इस टैब की मेमोरी में रहते हैं और अनुमति के दौरान सर्वर पर अस्थायी रूप से एन्क्रिप्ट होते हैं।
is_aiवैकल्पिकboolean· बॉडीप्रवाह को AI-सहायता प्राप्त चिह्नित करें।
redirect_urlवैकल्पिकstring· बॉडीप्राधिकरण के बाद वैकल्पिक पूर्ण HTTP या HTTPS गंतव्य। URL में क्रेडेंशियल नहीं होने चाहिए।
scope_idsवैकल्पिकarray· बॉडीसूची के संख्यात्मक ID। सक्रिय अनुमतियाँ चुनें; अधिकतम 150 अलग अनुमतियाँ।
scopesवैकल्पिकarray· बॉडीअल्पविराम से अलग अनुमति नाम। पैरामीटर मौजूद होना चाहिए; खाली मान किसी अनुमति का अनुरोध नहीं करता।
titleवैकल्पिकstring· बॉडीऐप का नाम, अधिकतम 500 UTF-8 बाइट।
JSON अनुरोध बॉडी
{
"credentials": {
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
},
"scope_ids": [
6
],
"title": "Example integration"
}प्रतिक्रिया
HTTP 201- बनाया गया
application/jsonउदाहरण प्रतिक्रिया
{ "authorization_url": "https://kicktokengen.com/authorize/EXAMPLE_ID", "expires_at": "2030-01-02T12:00:00Z", "id": "EXAMPLE_ID", "retrieval_key": "EXAMPLE_PRIVATE_KEY", "status_url": "https://kicktokengen.com/api/v2/workflows/EXAMPLE_ID", "success": true } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
GET /api/v2/workflows/{id}
प्रवाह के क्रेडेंशियल प्राप्त करें
प्राधिकरण के बाद क्रेडेंशियल एक बार लौटाता है। प्रवाह की कुंजी को Bearer क्रेडेंशियल के रूप में भेजें। सफल प्राप्ति के बाद संग्रहीत क्रेडेंशियल दोबारा नहीं मिलते।
पैरामीटर
idआवश्यकstring· पथप्रवाह बनाते समय लौटाया गया उसका ID।
Authorizationआवश्यकBearer· हेडरप्रवाह बनाते समय लौटाई गई निजी प्राप्ति कुंजी। इसे सार्वजनिक लिंक में शामिल न करें।
प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "access_token": "EXAMPLE_ACCESS_TOKEN", "client_id": "EXAMPLE_CLIENT_ID", "expires_at": "2030-01-01T13:00:00Z", "expires_in": 3600, "refresh_token": "EXAMPLE_REFRESH_TOKEN", "scopes": [ "chat:write" ], "status": "authorized", "success": true, "token_type": "Bearer" } HTTP 202- प्राधिकरण अभी लंबित है
application/jsonउदाहरण प्रतिक्रिया
{ "status": "pending", "success": false } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 410- क्रेडेंशियल समाप्त हो गए या पहले ही प्राप्त किए जा चुके हैं
application/jsonउदाहरण प्रतिक्रिया
{ "message": "workflow credentials are no longer available", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
GET /api/v2/ai/workflows/create
GET से AI प्रवाह बनाएँ
केवल URL पढ़ सकने वाले क्लाइंट के लिए GET विकल्प। अनुमति नामों से प्रवाह बनाता है और निजी प्राप्ति URL लौटाता है। JSON प्रतिक्रिया text/plain के रूप में मिलती है।
पैरामीटर
titleवैकल्पिकstring· क्वेरीऐप का नाम, अधिकतम 500 UTF-8 बाइट।
scopesवैकल्पिकstring· क्वेरीअल्पविराम से अलग अनुमति नाम। पैरामीटर मौजूद होना चाहिए; खाली मान किसी अनुमति का अनुरोध नहीं करता।
scope_idsवैकल्पिकstring· क्वेरीसूची के संख्यात्मक ID। सक्रिय अनुमतियाँ चुनें; अधिकतम 150 अलग अनुमतियाँ।
ai_agentवैकल्पिकstring· क्वेरीवैकल्पिक AI क्लाइंट नाम, नियंत्रण अक्षरों के बिना अधिकतम 64 UTF-8 बाइट। यह स्रोत पहचानने के लिए है, प्रमाणीकरण के लिए नहीं।
प्रतिक्रिया
HTTP 201- बनाया गया
application/jsonउदाहरण प्रतिक्रिया
{ "authorization_url": "https://kicktokengen.com/authorize/EXAMPLE_ID", "id": "EXAMPLE_ID", "retrieval_url": "https://kicktokengen.com/api/v2/ai/workflows/EXAMPLE_ID/EXAMPLE_PRIVATE_KEY", "success": true } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
GET /api/v2/ai/workflows/{id}/{key}
GET से AI क्रेडेंशियल प्राप्त करें
निजी URL में प्राप्ति कुंजी होती है। JSON प्रतिक्रिया क्रेडेंशियल एक बार देती है; पूरे URL को पासवर्ड की तरह रखें।
पैरामीटर
idआवश्यकstring· पथप्रवाह बनाते समय लौटाया गया उसका ID।
keyआवश्यकstring· पथप्रवाह बनाते समय लौटाई गई निजी प्राप्ति कुंजी। इसे सार्वजनिक लिंक में शामिल न करें।
प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "access_token": "EXAMPLE_ACCESS_TOKEN", "client_id": "EXAMPLE_CLIENT_ID", "expires_at": "2030-01-01T13:00:00Z", "expires_in": 3600, "refresh_token": "EXAMPLE_REFRESH_TOKEN", "scopes": [ "chat:write" ], "status": "authorized", "success": true, "token_type": "Bearer" } HTTP 202- प्राधिकरण अभी लंबित है
application/jsonउदाहरण प्रतिक्रिया
{ "status": "pending", "success": false } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 410- क्रेडेंशियल समाप्त हो गए या पहले ही प्राप्त किए जा चुके हैं
application/jsonउदाहरण प्रतिक्रिया
{ "message": "workflow credentials are no longer available", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/tokens/validate
टोकन की जाँच करें
टोकन की वैधता जाँचें और Kick से मिले ऐप, प्रकार, अनुमतियाँ और समाप्ति दिखाएँ।
पैरामीटर
access_tokenआवश्यकstring· बॉडीदेखने या रद्द करने वाला Kick एक्सेस टोकन, oauth: उपसर्ग के बिना।
JSON अनुरोध बॉडी
{
"access_token": "EXAMPLE_ACCESS_TOKEN"
}प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "active": true, "client_id": "EXAMPLE_CLIENT_ID", "exp": 1893502800, "expires_in": 3600, "scope_details": [ { "description": "Send chat messages.", "scope": "chat:write" } ], "scopes": [ "chat:write" ], "success": true, "token_type": "user" } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid access token", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/tokens/refresh
रिफ़्रेश टोकन
रिफ्रेश टोकन से एक्सेस टोकन नवीनीकृत करता है। अपने Kick ऐप के टोकन के लिए client_id और client_secret दोनों दें।
पैरामीटर
client_idवैकल्पिकstring· बॉडीKick ऐप का क्लाइंट ID। KTG का साझा ऐप उपयोग करने के लिए इसे छोड़ दें।
client_secretवैकल्पिकstring· बॉडीKick ऐप का क्लाइंट सीक्रेट। रिफ्रेश अनुरोध में इसे client_id के साथ दें।
refresh_tokenआवश्यकstring· बॉडीखाते और Kick ऐप का नवीनतम रिफ्रेश टोकन।
JSON अनुरोध बॉडी
{
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"refresh_token": "EXAMPLE_REFRESH_TOKEN"
}प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "access_token": "EXAMPLE_ACCESS_TOKEN", "client_id": "EXAMPLE_CLIENT_ID", "expires_at": "2030-01-01T13:00:00Z", "expires_in": 3600, "refresh_token": "EXAMPLE_REFRESH_TOKEN", "scopes": [ "chat:write" ], "status": "authorized", "success": true, "token_type": "Bearer" } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid refresh token or client credentials", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/tokens/revoke
टोकन रद्द करें
POST बॉडी में दिए गए एक एक्सेस या रिफ्रेश टोकन को रद्द करें।
पैरामीटर
access_tokenवैकल्पिकstring· बॉडीदेखने या रद्द करने वाला Kick एक्सेस टोकन, oauth: उपसर्ग के बिना।
refresh_tokenवैकल्पिकstring· बॉडीखाते और Kick ऐप का नवीनतम रिफ्रेश टोकन।
JSON अनुरोध बॉडी
{
"access_token": "EXAMPLE_ACCESS_TOKEN"
}प्रतिक्रिया
HTTP 200- सफल प्रतिक्रिया
application/jsonउदाहरण प्रतिक्रिया
{ "revoked": true, "success": true } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid token request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/quick-links
क्विक लिंक
चुनी अनुमति ID से दोबारा उपयोग योग्य लिंक बनाता है। auth=stay जनरेटर खोलता है; auth=authorize Kick प्राधिकरण शुरू करता है।
पैरामीटर
authवैकल्पिकstring· बॉडीstay जनरेटर खोलता है। authorize और संगतता उपनाम auth_auth तुरंत प्राधिकरण शुरू करते हैं।
scope_idsवैकल्पिकarray· बॉडीसूची के संख्यात्मक ID। सक्रिय अनुमतियाँ चुनें; अधिकतम 150 अलग अनुमतियाँ।
scopesवैकल्पिकarray· बॉडीअल्पविराम से अलग अनुमति नाम। पैरामीटर मौजूद होना चाहिए; खाली मान किसी अनुमति का अनुरोध नहीं करता।
JSON अनुरोध बॉडी
{
"auth": "stay",
"scope_ids": [
6
]
}प्रतिक्रिया
HTTP 201- बनाया गया
application/jsonउदाहरण प्रतिक्रिया
{ "success": true, "url": "https://kicktokengen.com/quick/Ab3dEf8_" } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }
POST /api/v2/token-requests
टोकन माँगें
प्राधिकरण अनुरोध लिंक बनाता है। खाते का मालिक प्राधिकरण पूरा करने पर क्रेडेंशियल my_email पर भेजे जाते हैं।
पैरामीटर
credentialsवैकल्पिकobject· बॉडीअपना Kick डेवलपर ऐप इस्तेमाल करें। दोनों फ़ील्ड केवल साझा मोड उपलब्ध होने पर खाली छोड़ें। क्रेडेंशियल इस टैब की मेमोरी में रहते हैं और अनुमति के दौरान सर्वर पर अस्थायी रूप से एन्क्रिप्ट होते हैं।
my_emailआवश्यकstring· बॉडीअनुरोध पूरा होने पर क्रेडेंशियल प्राप्त करने वाला ईमेल पता।
my_nameआवश्यकstring· बॉडीअनुरोधकर्ता का नाम, अधिकतम 128 UTF-8 बाइट।
scope_idsवैकल्पिकarray· बॉडीसूची के संख्यात्मक ID। सक्रिय अनुमतियाँ चुनें; अधिकतम 150 अलग अनुमतियाँ।
scopesवैकल्पिकarray· बॉडीअल्पविराम से अलग अनुमति नाम। पैरामीटर मौजूद होना चाहिए; खाली मान किसी अनुमति का अनुरोध नहीं करता।
JSON अनुरोध बॉडी
{
"credentials": {
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
},
"my_email": "developer@example.com",
"my_name": "Example developer",
"scope_ids": [
6
]
}प्रतिक्रिया
HTTP 201- बनाया गया
application/jsonउदाहरण प्रतिक्रिया
{ "expires_at": "2030-01-02T12:00:00Z", "success": true, "url": "https://kicktokengen.com/request/EXAMPLE_ID" } HTTP 400- अमान्य अनुरोध
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid request", "success": false } HTTP 401- अमान्य टोकन या प्राप्ति कुंजी
application/jsonउदाहरण प्रतिक्रिया
{ "message": "invalid retrieval key", "success": false } HTTP 429- अनुरोध सीमा पूरी हुई
application/jsonउदाहरण प्रतिक्रिया
{ "message": "rate limit exceeded", "success": false } HTTP 503- सेवा अस्थायी रूप से उपलब्ध नहीं है
application/jsonउदाहरण प्रतिक्रिया
{ "message": "Service unavailable", "success": false }