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	زمرہ سلگ فلٹر کریں
`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

Webhooks ریئل ٹائم اطلاعات وصول کرنے کی اجازت دیتے ہیں، جب آرڈرز یا کوڈز فراہم کیے جاتے ہیں۔ Webhook-URLs گاہک اکاؤنٹ میں محفوظ کیے جا سکتے ہیں۔

دستیاب 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 سے منسلک ہے۔