हमारा पीडीएफ एपीआई क्या उजागर करता है - क्रेडिट और सीमाएं
एपीआई पेज एपीआई की तुलना में तेजी से बढ़ते हैं। हमारा अब केवल उन मार्गों को सूचीबद्ध करता है जो ब्राउज़र के बिना समाप्त होते हैं: खाता, रिडक्ट और तुलना। वह जानबूझकर किया गया है। एक समापन बिंदु जो अपना कार्यप्रवाह पूरा नहीं कर सकता, वह समापन बिंदु न होने से भी बदतर है।
आज क्या लाइव है
- प्राप्त करें /v1/me - खाता, योजना और लाइव क्रेडिट बैलेंस; प्रति कॉल 1 क्रेडिट.
- पोस्ट /v1/redact-pdf - पैटर्न, टेक्स्ट या छवियां ढूंढें और एक संशोधित पीडीएफ लौटाएं
apply=1. मुक्त। - पोस्ट /v1/तुलना-पीडीएफ - आँकड़े, परिवर्तित ब्लॉक और दो पीडीएफ के बीच मुख्य अंतर। मुक्त।
तीनों मेरे खाते से एक बियरर कुंजी लेते हैं। परिणाम एक डाउनलोड लिंक के साथ JSON हैं जो दो घंटे तक रहता है; मूल को कभी भी उसी स्थान पर संशोधित नहीं किया जाता है।
एपीआई में क्या नहीं है
एपीआई आज क्या शुल्क लेता है
केवल तीन मार्ग मौजूद हैं: GET /v1/me जबकि लागत 1 क्रेडिट है POST /v1/redact-pdf और POST /v1/compare-pdf प्रत्येक की कीमत 5 क्रेडिट है। कोई मर्ज या ओसीआर एपीआई शुल्क नहीं हैं क्योंकि वे उपकरण एपीआई एंडपॉइंट नहीं हैं। लाइव दरें चालू हैं योजनाएं और मूल्य निर्धारण पेज.
ई-हस्ताक्षरकर्ता एक मार्ग क्यों नहीं है?
हस्ताक्षर करना एक ब्राउज़र वर्कफ़्लो है जो दो बार से अधिक होता है: प्रेषक पृष्ठ पर फ़ील्ड रखता है, और प्राप्तकर्ता एक लिंक खोलता है और हस्ताक्षर करता है। एक HTTP क्लाइंट लेआउट नहीं देख सकता है या उस पेज को संचालित नहीं कर सकता है, इसलिए "ई-साइन एपीआई" कार्य समाप्त होने से पहले बंद हो जाएगा। लिफ़ाफ़े ई-हस्ताक्षरकर्ता डैशबोर्ड में रहते हैं; एपीआई उन्हें बनाता या हस्ताक्षरित नहीं करता है।
कुंजियाँ और फ़ाइल प्रतिधारण
एपीआई कुंजी को पासवर्ड की तरह समझें: प्रति एप्लिकेशन एक कुंजी, यदि इसे सार्वजनिक रिपॉजिटरी में चिपकाया गया है तो इसे घुमाएं, और इसे कभी भी ब्राउज़र-साइड जावास्क्रिप्ट में न डालें। अपलोड की गई फ़ाइलें एक अकल्पनीय आईडी के साथ अस्थायी कार्यशील प्रतियां हैं; वे कोई दस्तावेज़ भंडार नहीं हैं. मूल प्रतियों को अपने भंडारण में रखें और एपीआई प्रतिक्रिया को व्युत्पन्न प्रति के रूप में मानें। द सुरक्षा पृष्ठ नियंत्रण और अवधारण विंडो सूचीबद्ध करता है।
अपग्रेड करने से पहले क्या मापना है
एक महीने के लिए तीन नंबर ट्रैक करें: सफल कॉल, असफल कॉल और अंत में क्रेडिट बैलेंस। Redact और Compare का भुगतान किया जाता है (प्रत्येक में 5 क्रेडिट), इसलिए शेष राशि में एक व्यस्त महीना दिखाई देता है; खाता कॉल लागत 1. यदि पुनः प्रयास या पीक-माह स्पाइक्स क्रेडिट का उपभोग करते हैं, तो एक बड़ी योजना एक असफल बैच की तुलना में सस्ती है। क्योंकि अप्रयुक्त क्रेडिट खत्म हो जाते हैं, एक शांत महीना बर्बाद नहीं होता है।
ई-हस्ताक्षरकर्ता केवल ब्राउज़र के लिए है। किसी को प्राप्तकर्ता के हस्ताक्षर फ़ील्ड को दृश्य रूप से रखना होगा, और प्राप्तकर्ता को एक हस्ताक्षर पृष्ठ खोलना होगा और उस पर हस्ताक्षर करना होगा। एक HTTP क्लाइंट ऐसा नहीं कर सकता है, इसलिए लिफाफे बनाने, हस्ताक्षर करने, सूची बनाने या मतदान करने के लिए कोई एपीआई मार्ग नहीं है। ई-हस्ताक्षरकर्ता डैशबोर्ड उस कार्य के लिए सही स्थान बना हुआ है।
वही परीक्षण अभी के लिए एपीआई से मर्ज, कंप्रेस, कन्वर्ट और संपादक को हटा देता है: उनका उपयोगी वर्कफ़्लो इंटरैक्टिव और फ़ाइल-भारी है। वे आधे-कार्यशील समापन बिंदु के रूप में विज्ञापित होने के बजाय ब्राउज़र में स्वतंत्र रहते हैं।
क्रेडिट क्या खरीदता है
क्रेडिट एक वाणिज्यिक खाते से जुड़ी प्रीपेड शेष राशि है। आज केवल सशुल्क एपीआई मार्ग ही हैं GET /v1/me 1 क्रेडिट पर और रिएक्ट करें और 5 क्रेडिट पर तुलना करें। योजनाओं में अभी भी मासिक क्रेडिट भत्ता शामिल है, और अप्रयुक्त क्रेडिट समाप्त होने के बजाय आगे बढ़ जाते हैं। हम लाइव एपीआई दरों को सूचीबद्ध करते हैं योजनाएं और मूल्य निर्धारण पेज और उन मार्गों के लिए प्रति-टूल कीमतें प्रकाशित न करें जो मौजूद नहीं हैं।
कुंजियाँ, सीमाएँ और सुरक्षा
एपीआई कुंजियाँ एक बार दिखाई जाती हैं और केवल हैश के रूप में संग्रहीत की जाती हैं। एक निरस्त कुंजी तुरंत काम करना बंद कर देती है। प्रति-कुंजी और प्रति-आईपी दर सीमा का उत्तर 429 के साथ Retry-After, अपलोड आकार और पृष्ठ संख्या के अनुसार सीमित होते हैं, और एक प्रतिबंधित या अनाधिकृत खाता लाइव कुंजी का उपयोग नहीं कर सकता है। द एपीआई पेज तीन मार्गों और उनके अनुरोध फ़ील्ड का दस्तावेज़ीकरण करता है।
आरंभ करना
एक खाता बनाएं, यदि आपको एपीआई कुंजी की आवश्यकता है तो एक वाणिज्यिक योजना सक्रिय करें, फिर मेरे खाते में कुंजी बनाएं और कॉल करें GET /v1/me प्रथम. यदि कोई ब्राउज़र टूल यह काम कर सकता है, तो ब्राउज़र टूल का उपयोग करें - यह निःशुल्क रहता है।