Dokumentasi B2B

B2B API – Dapatkan maklumat pesanan dan produk secara automatik

REST API kami tersedia untuk setiap pelanggan dengan akaun pelanggan dan membolehkan maklumat pesanan dan produk diperoleh secara automatik serta diintegrasikan ke dalam sistem anda sendiri.

vpn_key Buka akses API dalam akaun Halaman pelanggan perniagaan

Pengesahan

Semua permintaan API memerlukan API-Key yang sah, yang dihantar bersama dalam HTTP-Header. Akses API terikat dengan akaun pelanggan anda dan pada dasarnya tersedia untuk akaun pelanggan.

info Anda tidak memerlukan permohonan B2B yang berasingan: Log masuk dengan akaun pelanggan anda, buka tab API dan jana API-Key anda di sana. Ke akses API →

Format header

HTTP Request Header

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

Contoh dengan 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

Semua endpoint adalah relatif terhadap Base URL berikut:

Base URL

https://artumos.com/api/v1

Semua respons dikembalikan sebagai JSON (Content-Type: application/json).

Rate Limits

Plan	Permintaan / Minit	Permintaan / Hari
Akaun pelanggan	60	5.000
Had lanjutan	atas permintaan	atas permintaan

Apabila melebihi had, HTTP 429 Too Many Requests dikembalikan. Header Retry-After mengandungi masa menunggu dalam saat.

Kod ralat

HTTP-Code	Maksud
`200 OK`	Permintaan berjaya
`400 Bad Request`	Parameter tidak sah
`401 Unauthorized`	API-Key tiada atau tidak sah
`403 Forbidden`	Tiada kebenaran untuk sumber ini
`404 Not Found`	Sumber tidak dijumpai
`429 Too Many Requests`	Rate Limit melebihi had
`500 Internal Server Error`	Ralat pelayan – sila hubungi sokongan

Format Response ralat

JSON

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

Endpoint: Pesanan

GET /api/v1/orders Semua pesanan akaun

Parameter	Jenis	Penerangan
`page`	integer	Halaman (lalai: 1)
`per_page`	integer	Entri setiap halaman (maks. 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} Dapatkan pesanan tunggal

Endpoint: Maklumat produk dan pesanan

GET /api/v1/orders/{order_id}/codes Semua maklumat produk bagi sesuatu pesanan

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} Dapatkan maklumat produk tunggal

warning Maklumat produk dan pesanan hanya boleh digunakan dalam lingkungan pesanan dan maklumat penjual yang berkenaan. Penyebaran yang menyalahi guna boleh melanggar terma penggunaan.

Endpoint: Produk

GET /api/v1/products Dapatkan katalog produk

Parameter	Jenis	Penerangan
`category`	string	Tapis slug kategori
`in_stock`	boolean	Hanya produk yang tersedia
`page`	integer	Halaman

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 membolehkan penerimaan pemberitahuan masa nyata apabila pesanan atau kod disediakan. URL Webhook boleh disimpan dalam akaun pelanggan.

Event yang tersedia

Event	Penerangan
`order.paid`	Pesanan telah dibayar
`codes.delivered`	Kod telah disediakan
`order.refunded`	Pesanan telah dikembalikan wang

Webhook Payload

POST – Webhook-Endpoint anda

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

Sahkan tandatangan dengan Webhook-Secret anda: HMAC-SHA256(payload, webhook_secret)

Soalan lazim

Siapa yang boleh menggunakan B2B API?

Setiap pelanggan dengan akaun pelanggan boleh menggunakan akses API. Log masuk ke akaun pelanggan anda dan gunakan API-Key yang berkaitan untuk permintaan yang disahkan.

Apakah format respons?

Semua respons dikembalikan sebagai JSON. Objek root sentiasa mengandungi success: true/false serta sama ada data atau error.

Bolehkah saya membuat pesanan melalui API?

Dalam versi pertama, API berfungsi untuk mendapatkan pesanan, maklumat pesanan dan produk. Endpoint pesanan untuk menulis akan diaktifkan secara berasingan sebaik sahaja ia tersedia.

Adakah persekitaran Sandbox?

Ya. Sandbox boleh diaktifkan dalam akaun pelanggan pada tab „Akses API“ dan terikat terus dengan API-Key yang berkenaan.