मुझे API key कहाँ मिलेगी?

प्लेटफ़ॉर्म के संगठन सेक्शन में। वहाँ ओनर और एडमिन key बनाते हैं। key केवल एक बार दिखाई जाती है और हर संगठन के लिए ठीक एक key होती है।

किन प्लान में API शामिल है?

Starter, Professional और Enterprise में, निःशुल्क ट्रायल प्लान में नहीं। प्लान के पासपोर्ट कोटा में हर पासपोर्ट पर 10 API कॉल शामिल हैं। मौजूदा मान मूल्य पेज पर दिए गए हैं।

क्या कोई रेट लिमिट है?

अलग से कोई रेट लिमिट (HTTP 429) नहीं है। सीमा प्लान के कॉल कोटा से तय होती है। कोटा समाप्त होने पर API 402 के साथ जवाब देता है।

क्या मैं स्पेसिफ़िकेशन को Swagger UI या Postman में लोड कर सकता हूँ?

हाँ। OpenAPI 3.1 फ़ाइल JSON और YAML में डाउनलोड के लिए उपलब्ध है और इसे आम टूल और कोड जनरेटर में इम्पोर्ट किया जा सकता है।

डिजिटल उत्पाद पासपोर्ट API: डेवलपर्स के लिए दस्तावेज़

ग्राहक API की मदद से आपके अपने सिस्टम उत्पाद बनाते हैं, डेटा फ़ील्ड अपडेट करते हैं, पासपोर्ट प्रकाशित करते हैं और QR कोड व PDF डाउनलोड करते हैं। लॉग इन एक API key से होता है, जिसे आप प्लेटफ़ॉर्म में स्वयं बनाते हैं। पूरा विवरण OpenAPI 3.1 फ़ाइल के रूप में उपलब्ध है।

अंतिम अपडेट: 1 अक्टूबर 2026

अवलोकन

ग्राहक API, JSON का उपयोग करने वाला एक REST इंटरफ़ेस है। यह आपके संगठन के डेटा पर काम करता है, यानी उन्हीं उत्पादों और पासपोर्ट पर जो आप वेब एप्लिकेशन में देखते हैं। आम उपयोग हैं: ERP या PLM सिस्टम से जोड़ना, मास्टर डेटा का रात में सिंक, या कोई स्क्रिप्ट जो प्रिंट के लिए QR कोड लाती है।

बेस URL है https://dpp.com2u.selfhost.eu/api/v1/integration। QR कोड और PDF डाउनलोड को छोड़कर सभी जवाब JSON में होते हैं।

स्पेसिफ़िकेशन डाउनलोड करें

सभी एंडपॉइंट, फ़ील्ड, उदाहरणों और त्रुटि जवाबों का मशीन-पठनीय संदर्भ एक OpenAPI 3.1 स्पेसिफ़िकेशन है, जिसकी सुरक्षा स्कीम ApiKeyAuth है:

यही फ़ाइल API स्वयं GET /api/v1/integration/openapi.json पर बिना key के देता है। इसे Swagger UI, Postman या अपनी पसंद के कोड जनरेटर में इम्पोर्ट करें। फ़ाइल के अंदर के विवरण जर्मन भाषा में हैं।

क्विक स्टार्ट

रजिस्टर करें या लॉग इन करें। API सशुल्क प्लान का हिस्सा है, देखें मूल्य।
प्लेटफ़ॉर्म में संगठन सेक्शन खोलें और API key बनाएँ। इसे तुरंत कॉपी करें, क्योंकि यह केवल एक बार दिखाई जाती है।
कनेक्शन टेस्ट करें:

curl -H "X-API-Key: $DPP_API_KEY" \
  https://dpp.com2u.selfhost.eu/api/v1/integration/me

जवाब में आपका संगठन, key के scopes, आपका प्लान और API कॉल का उपयोग दिखाया जाता है।

प्रमाणीकरण

हर कॉल में key को X-API-Key हेडर में भेजें। Authorization: Bearer dpp_key_… भी इसी तरह काम करता है। संगठन हमेशा key से तय होता है; पैरामीटर के रूप में भेजी गई संगठन ID पर ध्यान नहीं दिया जाता। API वेब एप्लिकेशन के सेशन टोकन स्वीकार नहीं करता।

key उस व्यक्ति की होती है जिसने इसे बनाया है। कार्रवाइयाँ ओनर या एडमिन के रूप में उसी व्यक्ति की अनुमतियों से चलती हैं। यदि उस व्यक्ति से यह भूमिका हट जाती है, तो नई key बनने तक API 403 के साथ जवाब देता है। नई key बनाते ही पिछली key तुरंत रद्द हो जाती है। प्लेटफ़ॉर्म key का केवल SHA-256 हैश सहेजता है।

एंडपॉइंट

सभी पाथ /api/v1/integration के अंतर्गत हैं। हर एंडपॉइंट के लिए एक scope ज़रूरी है; नई key में चारों scope होते हैं।

मेथड और पाथ	उद्देश्य	Scope
`GET /me`	संगठन, scopes, प्लान, उपयोग	कोई भी key
`GET /schemas`	डेटा फ़ील्ड सहित स्कीमा	`products:read`
`POST /products`	उत्पाद बनाएँ, वैकल्पिक रूप से डेटा फ़ील्ड के साथ	`products:write`
`GET /products`	उत्पादों की सूची (`status`, `q`, `limit`, `offset`)	`products:read`
`GET /products/{id}`	उत्पाद पढ़ें	`products:read`
`GET /products/{id}/fields`	मौजूदा डेटा फ़ील्ड पढ़ें	`products:read`
`PATCH /products/{id}/fields`	डेटा फ़ील्ड सेट करें	`products:write`
`POST /products/{id}/passports`	पासपोर्ट बनाएँ और प्रकाशित करें	`passports:write`
`GET /products/{id}/passports`	पासपोर्ट संस्करणों की सूची	`passports:read`
`POST /passports/{id}/publish`	ड्राफ़्ट संस्करण प्रकाशित करें	`passports:write`
`GET /products/{id}/passport/qr`	PNG या SVG में QR कोड	`passports:read`
`GET /products/{id}/passport/pdf`	PDF के रूप में पासपोर्ट	`passports:read`

उत्पाद बनाएँ

name अनिवार्य है। schema_key के बिना आपके संगठन का डिफ़ॉल्ट स्कीमा लागू होता है; उपलब्ध keys GET /schemas से मिलती हैं। डेटा फ़ील्ड सीधे साथ में भेजे जा सकते हैं। field_status से आप मानों की स्थिति तय करते हैं, और केवल approved मान ही पासपोर्ट में जाते हैं।

curl -X POST https://dpp.com2u.selfhost.eu/api/v1/integration/products \
  -H "X-API-Key: $DPP_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Battery module X1","category":"Industrial batteries",
       "manufacturer_ref":"ART-4711","schema_key":"battery-v1",
       "fields":{"battery_chemistry":"LFP"},"field_status":"approved"}'

स्टेटस 201 वाले जवाब में उत्पाद की id होती है। यही वह विशिष्ट उत्पाद पहचानकर्ता भी है जो QR कोड में होता है। आपके प्लान का उत्पाद कोटा वेब एप्लिकेशन की तरह ही लागू होता है।

पासपोर्ट प्रकाशित करें, QR कोड और PDF डाउनलोड करें

पासपोर्ट स्वीकृत डेटा फ़ील्ड को एक नए संस्करण के रूप में स्थिर कर देता है। यदि अनिवार्य फ़ील्ड गायब हैं, तो API 422 के साथ जवाब देता है और उन्हें missing_fields में बताता है।

curl -X POST -H "X-API-Key: $DPP_API_KEY" \
  https://dpp.com2u.selfhost.eu/api/v1/integration/products/{id}/passports

curl -o qr.png -H "X-API-Key: $DPP_API_KEY" \
  "https://dpp.com2u.selfhost.eu/api/v1/integration/products/{id}/passport/qr?format=png&size=600"

curl -o passport.pdf -H "X-API-Key: $DPP_API_KEY" \
  https://dpp.com2u.selfhost.eu/api/v1/integration/products/{id}/passport/pdf

वेक्टर रूप में QR कोड के लिए format=svg का उपयोग करें। PDF केवल प्रकाशन के बाद उपलब्ध होता है; उससे पहले API 404 के साथ जवाब देता है। QR कोड सार्वजनिक पासपोर्ट पेज की ओर ले जाता है, अधिक जानकारी के लिए देखें Excel से डिजिटल उत्पाद पासपोर्ट बनाएँ।

त्रुटि कोड

स्टेटस	अर्थ
401	key गायब, अमान्य, रद्द या समाप्त
402	कोटा समाप्त: API कॉल, उत्पाद या पासपोर्ट
403	scope गायब, प्लान में API नहीं, key बनाने वाला अब ओनर या एडमिन नहीं, संगठन ब्लॉक
404	ऑब्जेक्ट नहीं मिला या किसी अन्य संगठन का है
422	अमान्य इनपुट, अज्ञात फ़ील्ड या अनिवार्य फ़ील्ड गायब

401 और 403 पर detail में code और message वाला एक ऑब्जेक्ट होता है, उदाहरण के लिए insufficient_scope या api_not_in_plan। 402 पर detail संसाधन, सीमा और अब तक का उपयोग बताता है।

सीमाएँ

API के ज़रिए आप उत्पाद स्तर के डेटा फ़ील्ड सेट करते हैं। बैच या अलग-अलग आइटम के फ़ील्ड आप वेब एप्लिकेशन में अपडेट करते हैं। कोई रेट लिमिट नहीं है, लेकिन हर प्लान का एक कॉल कोटा है; हर प्रमाणित कॉल गिनी जाती है। स्पेसिफ़िकेशन डाउनलोड करना नहीं गिना जाता। मौजूदा प्लान और कोटा मूल्य पेज पर दिए गए हैं। API के बिना बल्क इम्पोर्ट के लिए डेटा टेम्पलेट का उपयोग करें।

अक्सर पूछे जाने वाले प्रश्न

मुझे API key कहाँ मिलेगी?: प्लेटफ़ॉर्म के संगठन सेक्शन में। वहाँ ओनर और एडमिन key बनाते हैं। key केवल एक बार दिखाई जाती है और हर संगठन के लिए ठीक एक key होती है।
किन प्लान में API शामिल है?: Starter, Professional और Enterprise में, निःशुल्क ट्रायल प्लान में नहीं। प्लान के पासपोर्ट कोटा में हर पासपोर्ट पर 10 API कॉल शामिल हैं। मौजूदा मान मूल्य पेज पर दिए गए हैं।
क्या कोई रेट लिमिट है?: अलग से कोई रेट लिमिट (HTTP 429) नहीं है। सीमा प्लान के कॉल कोटा से तय होती है। कोटा समाप्त होने पर API 402 के साथ जवाब देता है।
क्या मैं स्पेसिफ़िकेशन को Swagger UI या Postman में लोड कर सकता हूँ?: हाँ। OpenAPI 3.1 फ़ाइल JSON और YAML में डाउनलोड के लिए उपलब्ध है और इसे आम टूल और कोड जनरेटर में इम्पोर्ट किया जा सकता है।

अपने उत्पाद डेटा से शुरुआत करें

30 दिन निःशुल्क ट्रायल करें: डेटा इम्पोर्ट करें, उसकी जाँच करें और उसे उत्पाद पासपोर्ट के रूप में प्रकाशित करें।

30 दिन निःशुल्क ट्रायल करें