v3.0.0

API दस्तावेज़ीकरण

Alyachan API सेवाओं को एकीकृत करने के लिए संपूर्ण गाइड। सुरक्षित और स्केलेबल RESTful मानकों के साथ AI एंडपॉइंट्स, मीडिया डाउनलोडर्स और डेटा उपयोगिताओं तक पहुंचें।

01 — आरंभ करना

खाता सेटअप

API एंडपॉइंट्स तक पहुंच के लिए सत्यापित खाते की आवश्यकता होती है। हम आपकी एकीकरण प्रक्रिया को तेज करने के लिए लचीले पंजीकरण विकल्प (ईमेल, Google, Discord) प्रदान करते हैं।

API कीज़ प्रबंधन

लॉग इन करने के बाद, <strong>API KEY</strong> टैब पर खाता डैशबोर्ड पर जाएं। यह की आपके एप्लिकेशन की गुप्त क्रेडेंशियल है।

◦ अपनी API की प्राप्त करने के लिए, कृपया "कॉपी" बटन दबाएं

अपनी API की को कभी भी क्लाइंट-साइड कोड या सार्वजनिक रिपॉजिटरी में साझा न करें।

◦ अपनी API की बदलने के लिए, कृपया "की जेनरेट करें" बटन के बाद "की अपडेट करें" बटन दबाएं

IP व्हाइटलिस्टिंग सब्सक्राइब प्लान

सुरक्षा सुविधा जो केवल पंजीकृत सर्वर IP पते से API की एक्सेस को प्रतिबंधित करती है। आपको अपनी API की का उपयोग करने से पहले IP सेटअप करना होगा

स्टैटिक IP: प्रोडक्शन सर्वर IP को मैन्युअल रूप से पंजीकृत करें।
सभी की अनुमति दें: यदि सर्वर डायनामिक IP का उपयोग करता है तो इस विकल्प को चेक करें (प्रोडक्शन के लिए अनुशंसित नहीं)।

02 — एकीकरण

लाइब्रेरी इंस्टॉलेशन

आधिकारिक SDK

npm install @alyachan/api

सामान्य HTTP

npm install axios

उपयोग के उदाहरण

एंडपॉइंट्स प्राप्त करने / खोजने के लिए, कृपया देखें API संदर्भ

मुख्य सर्वर : https://api.alyachan.dev

बैकअप सर्वर :

https://api-v2.alyachan.dev

index.js (SDK)अनुशंसित

const AlyaApi = require('@alyachan/api').default
const Api = AlyaApi('https://api.alyachan.dev/api', 'sk_prod_xxxxxxxx')

async function main() {
  try {
    const res = await Api.post('/ai/text2img', {
      'prompt': 'Cyberpunk city',
      'models': 'Japanese'
    })
    console.log(res)
  } catch (e) {
    console.error(e)
  }
}

request.js (Axios) POST

const axios = require('axios')

const config = {
  'method': 'POST',
  'url': 'https://api.alyachan.dev/api/ai/text2img',
  'headers': {
    'Authorization': 'Bearer sk_prod_xxxxxxxx',
    'Content-Type': 'application/json'
  },
  'data': { 'prompt': 'Cyberpunk city', 'models': 'Japanese' }
}

axios(config)
  .then(r => console.log(r.data))
  .catch(e => console.error(e))

मानक प्रतिक्रियाएं

कोड	अर्थ	विवरण
200	OK	अनुरोध सफलतापूर्वक संसाधित किया गया।
400	खराब अनुरोध	इनपुट पैरामीटर गलत हैं या गायब हैं।
401	अनधिकृत	अमान्य API की या प्रदान नहीं की गई।
429	दर सीमा	दैनिक अनुरोध सीमा पार हो गई।