यो सूचीकरणको बारेमा
अधिकांश API कागजातहरू कहाँ चुक्छन्
धेरैजसो गाइडहरूले अन्तिम बिन्दुहरू (endpoints) त सूचीबद्ध गर्छन्, तर वास्तवमै अन्योल सिर्जना गर्ने विवरणहरू भने छुटाउँछन्: व्यवहारमा प्रमाणीकरण कसरी काम गर्छ, अनुरोध र प्रतिक्रियाका यथार्थ उदाहरणहरू, अनि विशिष्ट त्रुटिहरूको अर्थ के हो र तिनलाई कसरी समाधान गर्ने। यस्तो हुँदा, विकासकर्ताहरूले सपोर्ट टिकट पेश गर्नुपर्ने हुन्छ, जसले कागजात हुनुको उद्देश्यलाई नै समाप्त गरिदिन्छ।
हाम्रो दृष्टिकोण
हामी अनुमानमा भर पर्नुको सट्टा सिधै तपाईंको स्रोत कोडबाट निर्माण गर्छौं। हामी प्रत्यक्ष प्रमाणहरू (live credentials) प्रयोग गरेर आफैं API परीक्षण गर्नुअघि तपाईंको रुटहरू, प्रमाणीकरण तर्क र त्रुटि व्यवस्थापनको निरीक्षण गर्छौं। अन्तिम कागजातमा समावेश प्रत्येक उदाहरणले हामीले पठाएको वास्तविक अनुरोध र हामीले प्राप्त गरेको वास्तविक प्रतिक्रियालाई प्रतिनिधित्व गर्छ, जसले गर्दा कुनै पनि मनगढन्ते विवरण वा असम्भव स्थिति कोडहरू रहँदैनन्।
तपाईंले के प्राप्त गर्नुहुन्छ
- प्रमाणीकरण मार्गदर्शन: टोकन जारी गर्ने, रिफ्रेस गर्ने, र सत्रको बीचमै यो समाप्त भएमा के हुन्छ।
- प्यारामिटरहरू, एउटा काम गर्ने उदाहरण अनुरोध र वास्तविक प्रतिक्रिया संरचना सहित प्रत्येक अन्तिम बिन्दुको पूर्ण विवरण।
- केवल दोहोर्याइएको सन्देश मात्र नभई, प्रत्येक कोडलाई त्यसको कारण र समाधानसँग जोड्ने त्रुटि सन्दर्भ।
- नयाँ विकासकर्तालाई शून्यबाट सफल कलसम्म पुर्याउन डिजाइन गरिएको द्रुत-सुरुवात मार्ग।
- सान्दर्भिक भएसम्म दर सीमा, पृष्ठसंख्या (pagination), वेबहुकहरू र इडेम्पोटेन्सी सम्बन्धी नोटहरू।
वितरण ढाँचा
हामी तपाईंको भण्डार (repository) का लागि उपयुक्त हुने गरी Markdown प्रदान गर्छौं, जसलाई तपाईंको टोलीले अद्यावधिक राख्ने OpenAPI वा कागजात साइटमा मिल्ने गरी संरचना गरिएको हुन्छ। तपाईंका प्रयोगकर्ताहरूले भर पर्ने भाषाहरूमा कोड नमूनाहरू प्रदान गरिन्छ र तिनीहरूलाई सञ्चालन गरेर परीक्षण गरिन्छ। अनुरोध गरिएमा Postman-शैलीको सङ्कलन पनि समावेश गर्न सकिन्छ।
हामीलाई तपाईंबाट के चाहिन्छ
तपाईंको भण्डार वा OpenAPI फाइलमा पहुँच, परीक्षण वातावरणको लागि काम गर्ने प्रमाणहरू, र तपाईंका सपोर्ट कर्मचारीहरूले प्रायः जवाफ दिने प्रश्नहरू - यिनैले गाइडको संरचनालाई आकार दिन्छन्।
के समावेश छैन
यो सेवाले सफ्टवेयरले कसरी काम गर्छ भन्ने कुराको सटीक प्राविधिक कागजातलाई समेट्छ; प्रवर्द्धनात्मक वा मार्केटिङ प्रतिलिपि छुट्टै काम हो।
प्रक्रिया र समयसीमा
तपाईंले एउटा पूर्ण पहिलो मस्यौदा प्राप्त गर्नुहुनेछ, जसलाई तपाईंले आफ्नो सपोर्ट टोलीले सामना गर्ने बारम्बारका प्रश्नहरूसँग दाँजेर हेर्न सक्नुहुन्छ। हामी कुनै परिष्कृत तर गलत कुरा हस्तान्तरण गर्नुभन्दा इन्जिनियरले सुरुमै कुनै जटिल अवस्था (edge case) औंल्याइदिएको रुचाउँछौं। प्रत्येक उदाहरण तपाईंको प्रत्यक्ष API विरुद्ध चलाएर हेरिएको हुनाले, अन्तिम कागजातमा कुनै पनि कुरा सैद्धान्तिक मात्र हुँदैन।
यो प्याकेजले 500.99 अमेरिकी डलर र १० दिनको समयावधिमा, संशोधनको एक चरण सहित, एकल चरणमा डेलिभर गरिने एउटा निश्चित-मूल्यको API कागजात दायरालाई समेट्छ। तपाईंले अर्डर सम्बन्धित डोमेन र आफ्नो संक्षिप्त विवरण (brief) उपलब्ध गराउनु पर्नेछ।