API दस्तावेज़

सारांश

Orbitex API आपको कंप्रेस, मर्ज, विभाजन और कन्वर्ज़न को अपने ऐप्लिकेशन, स्क्रिप्ट और CI पाइपलाइन में जोड़ने देता है। सभी अनुरोध HTTPS पर होते हैं और उनके लिए API कुंजी चाहिए।

API अभी बन रहा है। एंडपॉइंट, दर सीमाएँ और प्रमाणीकरण का ब्योरा सार्वजनिक बीटा से पहले यहीं प्रकाशित किया जाएगा।

प्रमाणीकरण

अनुरोधों में आपकी API कुंजी वाला Authorization हेडर शामिल होता है:

• कुंजियाँ आपके Orbitex डैशबोर्ड में बनती हैं (Business प्लान)।
• अगर कोई कुंजी लीक हो जाए तो डैशबोर्ड से उसे बदल दें।
• कुंजियों को कभी क्लाइंट-साइड JavaScript या सार्वजनिक रिपॉज़िटरी में उजागर न करें।

प्रस्तावित एंडपॉइंट

शुरुआती API में ये शामिल होंगे:

• POST /v1/pdf/compress - PDF फ़ाइल का आकार घटाएँ
• POST /v1/pdf/merge - कई PDF जोड़ें
• POST /v1/pdf/split - पेज या रेंज के हिसाब से विभाजित करें
• POST /v1/pdf/convert - PDF से Word, Excel और वापस
• POST /v1/pdf/protect - पासवर्ड से एन्क्रिप्ट करें
• GET /v1/jobs/{id} - असिंक्रोनस जॉब की स्थिति देखें

फ़ाइल हैंडलिंग

अपलोड की गई फ़ाइलों पर वही सुरक्षा और विलोपन नियम लागू होते हैं जो वेब इंटरफ़ेस पर। रिटेंशन अवधि और एन्क्रिप्शन के ब्योरे के लिए फ़ाइल सुरक्षा नीति देखें।

लंबे चलने वाले काम पूरे होने पर वेबहुक आपके सर्वर को सूचित करेंगे।

दर सीमाएँ

दर सीमाएँ प्लान के स्तर पर निर्भर करती हैं। मुफ़्त स्तर पर API एक्सेस देने की योजना नहीं है। Business ग्राहकों को लिखित सीमाएँ और बर्स्ट भत्ते मिलते हैं।

अर्ली एक्सेस पाएँ

हमें अपना उपयोग बताएँ - बैच कन्वर्ज़न, दस्तावेज़ पाइपलाइन, SaaS इंटीग्रेशन - और बीटा खुलने पर हम आपको सूचित करेंगे।