Orbit API टोकन और REST API

API टोकन एक स्क्रिप्ट, CI पाइपलाइन या आपके स्वयं के टूलिंग को ब्राउज़र सेशन के बिना Kapsule Orbit को संचालित करने देते हैं: डिप्लॉयमेंट ट्रिगर करें, CI चेक परिणाम रिपोर्ट करें, बिल्ड आर्टिफैक्ट डाउनलोड करें, cron जॉब प्रबंधित करें और बहुत कुछ, सभी एक Bearer टोकन के साथ प्रमाणित जिसे आप स्वयं स्कोप करते हैं।

टोकन कहाँ होते हैं

Kapsule Orbit खोलें और शीर्ष-स्तरीय नेविगेशन से Tokens चुनें। पृष्ठ का शीर्षक API Access Tokens है और यह शुरुआत में अपना नियम बताता है: टोकन निर्माण के समय केवल एक बार दिखाई देते हैं।

संपूर्ण endpoint दस्तावेज़ीकरण एक क्लिक दूर बैठता है। API Reference कार्ड में एक View docs बटन है जो Kapsule Orbit के हर endpoint के लिए पैनल-में संदर्भ खोलता है।

एक टोकन बनाना

1. New token पर क्लिक करें।
2. इसे एक Token name दें। इसका नाम उस चीज़ के बाद रखें जो इसका उपयोग करेगी, उदाहरण के लिए CI वर्कफ़्लो, ताकि सूची बाद में पठनीय हो।
3. इसके Scopes चुनें।
4. वैकल्पिक रूप से एक Expiry सेट करें। एक टोकन के लिए जो समाप्त न हो इसे खाली छोड़ें।
5. Create token पर क्लिक करें।

कच्चा टोकन एक बार प्रदर्शित होता है, One-time reveal शीर्षक के अंतर्गत, एक कॉपी बटन के साथ। इसे सीधे अपने CI सीक्रेट स्टोर में पेस्ट करें। इसे फिर से देखने का कोई तरीका नहीं है: केवल टोकन का SHA-256 हैश स्टोर किया जाता है, इसलिए KapsuleHost भी इसे आपके लिए पुनः प्राप्त नहीं कर सकता।

एक खाता 20 सक्रिय टोकन तक रख सकता है। इक्कीसवां टोकन बनाना एक संदेश के साथ अस्वीकार कर दिया जाता है जो आपको पहले एक मौजूदा को रद्द करने के लिए कहता है।

Scopes

Scopes टोकन का पूरा बिंदु हैं: प्रत्येक केवल वह अनुमति देता है जो आपने इसे दी।

एक नया टोकन deploy:write और project:read को डिफ़ॉल्ट करता है, जो एक डिप्लॉयमेंट पाइपलाइन को आवश्यक है और कुछ नहीं।

सबसे छोटा सेट अनुदान दें जो काम करता है। एक टोकन जिसे केवल CI परिणाम रिपोर्ट करने की आवश्यकता है उसे project:write की आवश्यकता नहीं है। एक केवल-पढ़ने-के-लिए निगरानी स्क्रिप्ट को कोई लिखने वाली scope की आवश्यकता नहीं है। संदर्भ में प्रत्येक endpoint न्यूनतम scope को सूचीबद्ध करता है जिसकी इसे आवश्यकता है।

एक टोकन का उपयोग करना

प्रमाणीकरण API बेस के विरुद्ध एक Bearer हेडर है, https://kapsulehost.com:

curl -X POST https://kapsulehost.com/api/orbit/$ORBIT_PROJECT_ID/deployments \
  -H "Authorization: Bearer $ORBIT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"branch":"main"}'

Tokens पृष्ठ एक तैयार-निर्मित CI/CD usage स्निपेट और एक GitHub Actions starter वर्कफ़्लो ले जाता है। starter को .github/workflows/orbit-deploy.yml के रूप में सहेजा जाता है और दो रिपोजिटरी सीक्रेट की आवश्यकता होती है, ORBIT_TOKEN और ORBIT_PROJECT_ID। इन्हें पृष्ठ से कॉपी करें न कि उन्हें ट्रांसक्राइब करें।

API क्या कवर करता है

पैनल-में संदर्भ प्रत्येक क्षेत्र को अपने पैरामीटर और आवश्यक scope के साथ दस्तावेज़ करता है:

• Deployments: एक डिप्लॉयमेंट ट्रिगर करें, वैकल्पिक रूप से एक नाम की गई ब्रांच पर, वैकल्पिक रूप से भविष्य के समय के लिए पाँच मिनट से तीस दिन आगे शेड्यूल किया जाए, 500 वर्णों तक के नोट के साथ। सूचीकरण कमिट, संदेश, ब्रांच और लेखक में फजी खोज को समर्थन करता है, साथ ही ब्रांच, स्थिति और पर्यावरण पर फ़िल्टर करता है, कर्सर पेजिनेशन के साथ प्रति पृष्ठ 100 परिणामों तक।
• Deployment checks: अपने CI जॉब की शुरुआत में एक गुणवत्ता गेट पंजीकृत करें, फिर यह समाप्त होने पर परिणाम रिपोर्ट करें। एक required चेक जो विफल हो जाता है डिप्लॉयमेंट को FAILED में ले जाता है और पर्यावरण को पिछले सफल डिप्लॉयमेंट में वापस लाता है, जो कि आप अपने स्वयं के टेस्ट सूट को एक सच्चा डिप्लॉय गेट कैसे बनाते हैं।
• Branch protection: glob-पैटर्न नियम जो स्वचालित डिप्लॉयमेंट को ब्लॉक करते हैं जब तक आवश्यक चेक पास न हों और, वैकल्पिक रूप से, कोई अनुमोदन न करे। प्रति प्रोजेक्ट 10 नियमों तक।
• Build artifacts: एक सफल डिप्लॉयमेंट के संकलित आउटपुट के लिए एक पूर्व-हस्ताक्षरित डाउनलोड URL प्राप्त करें। URL पंद्रह मिनट के लिए मान्य है।
• Project transfer: दूसरे खाते में स्थानांतरण शुरू करें, रद्द करें और स्थिति की जाँच करें। Kapsule Orbit प्रोजेक्ट स्थानांतरण देखें।
• Cron jobs: सूचीबद्ध करें, बनाएँ, अपडेट करें, हटाएँ, ट्रिगर करें, और निष्पादन इतिहास पढ़ें। Kapsule Orbit Cron Jobs देखें।
• Timeline annotations: घटना, रिलीज़, माइलस्टोन, नोट और फ़्लैग एनोटेशन बनाएँ और प्रबंधित करें। Kapsule Orbit Timeline Annotations देखें।
• Status page: सार्वजनिक स्थिति पृष्ठ कॉन्फ़िगरेशन को पढ़ें और लिखें। Kapsule Orbit Status Page देखें।
• Edge functions: edge हैंडलर को सूचीबद्ध करें, बनाएँ, अपडेट करें और डिप्लॉय करें। Kapsule Orbit Edge Functions देखें।

पैनल से सेशन प्रमाणीकरण Bearer टोकन के साथ साथ काम करता है, इसलिए एक endpoint जिसे आप अपने ब्राउज़र से कॉल कर सकते हैं उसे आम तौर पर एक स्क्रिप्ट से भी कॉल किया जा सकता है।

Turbo Remote Cache

Tokens पृष्ठ एक Remote Build Cache कार्ड भी ले जाता है। यह Turborepo Remote Cache Protocol को लागू करता है, एक monorepo को CI रन और डेवलपर मशीनों के बीच बिल्ड कैश साझा करने देता है।

कार्ड पर इसे सक्षम करें, टोकन को कॉपी करें जो यह उत्पन्न करता है, और इसे अपने खाता ID के साथ TURBO_TEAM के रूप में अपने CI पर्यावरण में सेट करें। 150 MB तक की कलाकृतियाँ प्रत्येक स्वीकार की जाती हैं। कार्ड Rotate token और Disable भी प्रदान करता है।

यदि आपके monorepo की CI अपना अधिकतर समय पैकेजों को फिर से बनाने में खर्च करता है जो नहीं बदले हैं, तो यह पृष्ठ पर एकल सर्वोच्च-मूल्य की चीज़ है।

सूची का प्रबंधन

Token inventory प्रत्येक सक्रिय टोकन को सूचीबद्ध करता है:

• जब इसे Created किया गया था।
• जब इसे Last used किया गया था, या Never।
• जब इसे Expires, एक expired बैज के साथ एक बार समाप्त हो जाता है।

Last used कॉलम वह है जिसे ऑडिट करना है। एक टोकन जो कभी उपयोग नहीं किया गया वह गलत है या भूल गया है, और दोनों ही स्थितियों में यह एक क्रेडेंशियल है जो कुछ नहीं कर रहा। पृष्ठ का स्वयं का संकेत इसे स्पष्ट कहता है: कुछ भी रद्द करें जिसे आप पहचानते नहीं हैं।

एक टोकन को रद्द करना

पंक्ति पर रद्द करने का नियंत्रण क्लिक करें। पुष्टिकरण स्पष्ट है: उस टोकन के साथ प्रमाणित करने वाला सब कुछ तुरंत पहुँच खो देता है, और यह पूर्ववत् नहीं किया जा सकता।

जब कोई पाइपलाइन सेवानिवृत्त हो, जब आपके CI सीक्रेट तक पहुँच रखने वाला कोई व्यक्ति जाता है, या वह क्षण जब आप संदेह करते हैं कि एक टोकन लीक हो गया है, तब रद्द करें। कोई आंशिक रद्द करना नहीं और कोई ग्रेस अवधि नहीं है, जो लीक मामले में बिल्कुल वही है जो आप चाहते हैं।

समस्या निवारण

401 Unauthorized. हेडर गलत है या टोकन को रद्द कर दिया गया है या समाप्त हो गया है। जाँचें कि हेडर Authorization: Bearer <token> के साथ एक एकल स्पेस है, और कि आपका CI सीक्रेट में एक ट्रेलिंग न्यूलाइन नहीं है।

403 Forbidden. टोकन मान्य है लेकिन उस endpoint के लिए scope की कमी है। संदर्भ endpoint प्रति न्यूनतम scope को सूचीबद्ध करता है। Scopes निर्माण के समय निर्धारित होते हैं, इसलिए सही सेट के साथ एक नया टोकन बनाएँ।

429 on creation. आप बीस-टोकन की सीमा पर हैं। सूची से कुछ रद्द करें।

The artifact URL stops working. पूर्व-हस्ताक्षरित URLs पंद्रह मिनट तक रहते हैं। URL को स्टोर करने के बजाय एक ताज़ा अनुरोध करें।

A scheduled deployment is rejected. निर्धारित समय भविष्य में पाँच मिनट और तीस दिनों के बीच होना चाहिए।

अगला कहाँ जाएँ

• अपने प्रोजेक्ट को डिप्लॉय करना जो एक ट्रिगर किया गया डिप्लॉयमेंट वास्तव में करता है।
• Kapsule Orbit Deployment Pipeline यह देखने के लिए कि आपके API डिप्लॉयमेंट कौन से गेट को पूरा करेंगे।
• Kapsule Orbit Plan Limits आपकी योजना में क्या शामिल है।