B2B दस्तावेज़ीकरण

B2B API – ऑर्डर- और उत्पाद जानकारी स्वचालित रूप से प्राप्त करें

हमारी REST-API ग्राहक खाते वाले प्रत्येक ग्राहक के लिए उपलब्ध है और ऑर्डर- और उत्पाद जानकारी को स्वचालित रूप से प्राप्त करने और अपने स्वयं के सिस्टम में एकीकृत करने में सक्षम बनाती है।

vpn_key खाते में API-पहुँच खोलें व्यावसायिक ग्राहक-पृष्ठ

प्रमाणीकरण

सभी API-अनुरोधों के लिए एक वैध API-Key की आवश्यकता होती है, जो HTTP-Header में साथ भेजा जाता है। API-पहुँच आपके ग्राहक खाते से बंधी होती है और मूल रूप से ग्राहक खातों के लिए उपलब्ध है।

info आपको किसी अलग B2B-आवेदन की आवश्यकता नहीं है: अपने ग्राहक खाते से लॉग इन करें, API-टैब खोलें और वहाँ अपना API-Key जनरेट करें। API-पहुँच पर जाएँ →

Header-प्रारूप

HTTP Request Header

X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

cURL के साथ उदाहरण

cURL

curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

सभी एंडपॉइंट निम्नलिखित Base URL के सापेक्ष हैं:

Base URL

https://artumos.com/api/v1

सभी प्रतिक्रियाएँ JSON के रूप में लौटाई जाती हैं (Content-Type: application/json).

Rate Limits

Plan	अनुरोध / मिनट	अनुरोध / दिन
ग्राहक खाता	60	5.000
विस्तारित सीमा	अनुरोध पर	अनुरोध पर

सीमा पार होने पर HTTP 429 Too Many Requests लौटाया जाता है। Header Retry-After में प्रतीक्षा समय सेकंड में होता है।

त्रुटि कोड

HTTP-Code	अर्थ
`200 OK`	अनुरोध सफल
`400 Bad Request`	अमान्य पैरामीटर
`401 Unauthorized`	अनुपलब्ध या अमान्य API-Key
`403 Forbidden`	इस संसाधन के लिए कोई अनुमति नहीं
`404 Not Found`	संसाधन नहीं मिला
`429 Too Many Requests`	Rate Limit पार हो गई
`500 Internal Server Error`	सर्वर त्रुटि – कृपया समर्थन से संपर्क करें

त्रुटि-Response प्रारूप

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

एंडपॉइंट: ऑर्डर

GET /api/v1/orders खाते के सभी ऑर्डर

Parameter	प्रकार	विवरण
`page`	integer	पृष्ठ (मानक: 1)
`per_page`	integer	प्रति पृष्ठ प्रविष्टियाँ (अधिकतम 100)
`status`	string	`paid` \| `pending` \| `all`

Beispiel-Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}

GET /api/v1/orders/{order_id} एकल ऑर्डर प्राप्त करें

एंडपॉइंट: उत्पाद- और ऑर्डर जानकारी

GET /api/v1/orders/{order_id}/codes किसी ऑर्डर की सभी उत्पाद जानकारी

Beispiel-Response

{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}

GET /api/v1/codes/{code_id} एकल उत्पाद जानकारी प्राप्त करें

warning उत्पाद- और ऑर्डर जानकारी का उपयोग केवल संबंधित ऑर्डर और विक्रेता जानकारी के दायरे में किया जा सकता है। दुरुपयोगपूर्ण साझा करना उपयोग की शर्तों का उल्लंघन कर सकता है।

एंडपॉइंट: उत्पाद

GET /api/v1/products उत्पाद कैटलॉग प्राप्त करें

Parameter	प्रकार	विवरण
`category`	string	श्रेणी-Slug फ़िल्टर करें
`in_stock`	boolean	केवल उपलब्ध उत्पाद
`page`	integer	पृष्ठ

Beispiel-Response

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Webhook वास्तविक समय की सूचनाएँ प्राप्त करना संभव बनाते हैं, जब ऑर्डर या कोड प्रदान किए जाते हैं। Webhook-URL ग्राहक खाते में संग्रहीत किए जा सकते हैं।

उपलब्ध Events

Event	विवरण
`order.paid`	ऑर्डर का भुगतान किया गया
`codes.delivered`	कोड प्रदान किए गए
`order.refunded`	ऑर्डर वापस किया गया

Webhook Payload

POST – आपका Webhook-Endpoint

{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

अपने Webhook-Secret के साथ हस्ताक्षर सत्यापित करें: HMAC-SHA256(payload, webhook_secret)

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

B2B API का उपयोग कौन कर सकता है?

ग्राहक खाते वाला प्रत्येक ग्राहक API-पहुँच का उपयोग कर सकता है। अपने ग्राहक खाते में लॉग इन करें और प्रमाणित अनुरोधों के लिए संबंधित API-Key का उपयोग करें।

प्रतिक्रियाओं का प्रारूप क्या है?

सभी प्रतिक्रियाएँ JSON के रूप में लौटाई जाती हैं। Root-ऑब्जेक्ट में हमेशा success: true/false साथ ही या तो data या error.

क्या मैं API के माध्यम से ऑर्डर दे सकता हूँ?

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

क्या कोई Sandbox-वातावरण है?

हाँ। Sandbox को ग्राहक खाते में „API-पहुँच“ टैब में सक्रिय किया जा सकता है और यह सीधे संबंधित API-Key से बंधी होती है।