B2B na Dokumentasyon

B2B API – awtomatikong kumuha ng impormasyon ng order at produkto

Ang aming REST-API ay magagamit ng bawat customer na may customer account at nagbibigay-daan na awtomatikong kunin ang impormasyon ng order at produkto at isama ito sa sariling mga sistema.

vpn_key Buksan ang API na akses sa account Pahina ng mga negosyong customer

Pagpapatunay

Lahat ng API na kahilingan ay nangangailangan ng wastong API-Key na ipinapadala sa HTTP-Header. Ang API na akses ay nakatali sa iyong customer account at sa prinsipyo ay magagamit ng mga customer account.

info Hindi mo kailangan ng hiwalay na B2B na aplikasyon: Mag-log in gamit ang iyong customer account, buksan ang API-Tab at lumikha doon ng iyong API-Key. Sa API na akses →

Format ng Header

HTTP Request Header

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

Halimbawa gamit ang 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

Lahat ng endpoint ay relatibo sa sumusunod na Base URL:

Base URL

https://artumos.com/api/v1

Lahat ng tugon ay ibinabalik bilang JSON ibinabalik (Content-Type: application/json).

Rate Limits

Plan	Mga kahilingan / Minuto	Mga kahilingan / Araw
Customer account	60	5.000
Pinalawig na limitasyon	kapag hiniling	kapag hiniling

Kapag lumagpas, ibinabalik ang HTTP 429 Too Many Requests ibinabalik. Ang Header Retry-After ay naglalaman ng oras ng paghihintay sa segundo.

Mga error code

HTTP-Code	Kahulugan
`200 OK`	Matagumpay ang kahilingan
`400 Bad Request`	Hindi wastong mga parameter
`401 Unauthorized`	Nawawala o hindi wastong API-Key
`403 Forbidden`	Walang pahintulot para sa resource na ito
`404 Not Found`	Hindi natagpuan ang resource
`429 Too Many Requests`	Lumagpas sa Rate Limit
`500 Internal Server Error`	Error sa server – pakikontak ang suporta

Format ng Error-Response

JSON

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

Endpoint: Mga order

GET /api/v1/orders Lahat ng order ng account

Parameter	Uri	Paglalarawan
`page`	integer	Pahina (Default: 1)
`per_page`	integer	Mga entry bawat pahina (max. 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} Kunin ang isang order

Endpoint: Impormasyon ng produkto at order

GET /api/v1/orders/{order_id}/codes Lahat ng impormasyon ng produkto ng isang order

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} Kunin ang isang impormasyon ng produkto

warning Ang impormasyon ng produkto at order ay maaari lamang gamitin sa loob ng kani-kanilang order at impormasyon ng nagbebenta. Ang maling pagpapasa ay maaaring lumabag sa mga tuntunin ng paggamit.

Endpoint: Mga produkto

GET /api/v1/products Kunin ang katalogo ng produkto

Parameter	Uri	Paglalarawan
`category`	string	I-filter ang category-slug
`in_stock`	boolean	Mga magagamit na produkto lamang
`page`	integer	Pahina

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

Ang mga Webhook ay nagbibigay-daan na makatanggap ng mga real-time na abiso kapag ibinigay ang mga order o code. Ang mga Webhook-URL ay maaaring i-set up sa customer account.

Mga magagamit na Event

Event	Paglalarawan
`order.paid`	Nabayaran na ang order
`codes.delivered`	Naibigay na ang mga code
`order.refunded`	Nai-refund na ang order

Webhook Payload

POST – Ang iyong Webhook-Endpoint

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

I-verify ang lagda gamit ang iyong Webhook-Secret: HMAC-SHA256(payload, webhook_secret)

Mga madalas na tanong

Sino ang maaaring gumamit ng B2B API?

Bawat customer na may customer account ay maaaring gumamit ng API na akses. Mag-log in sa iyong customer account at gamitin ang kaugnay na API-Key para sa mga napatunayang kahilingan.

Anong format mayroon ang mga tugon?

Lahat ng tugon ay ibinabalik bilang JSON. Ang Root-Object ay palaging naglalaman ng success: true/false pati na rin ang alinman data o error.

Maaari ba akong maglagay ng order sa pamamagitan ng API?

Sa unang bersyon, ang API ay nagsisilbi sa pagkuha ng mga order, impormasyon ng order at produkto. Ang mga endpoint na nagsusulat ng order ay paghihiwalay na ia-activate sa sandaling magagamit ang mga ito.

Mayroon bang Sandbox na kapaligiran?

Oo. Ang Sandbox ay maaaring i-activate sa customer account sa Tab na „API na akses“ at direktang nakatali sa kani-kanilang API-Key.