B2B dokumentacija

B2B API – automatizuotai gaukite užsakymų ir produktų informaciją

Mūsų REST API prieinama kiekvienam klientui su kliento paskyra ir leidžia automatizuotai gauti užsakymų bei produktų informaciją ir integruoti ją į savo sistemas.

vpn_key Atidaryti API prieigą paskyroje Verslo klientų puslapis

Autentifikacija

Visos API užklausos reikalauja galiojančio API-Key, kuris siunčiamas HTTP antraštėje. API prieiga susieta su jūsų kliento paskyra ir iš esmės prieinama kliento paskyroms.

info Jums nereikia atskiros B2B paraiškos: prisijunkite su savo kliento paskyra, atidarykite API skirtuką ir ten sugeneruokite savo API-Key. Į API prieigą →

Antraštės formatas

HTTP Request Header

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

Pavyzdys su 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

Visi endpoints yra santykiniai šiam Base URL:

Base URL

https://artumos.com/api/v1

Visi atsakymai grąžinami kaip JSON grąžinama (Content-Type: application/json).

Rate Limits

Plan	Užklausos / minutė	Užklausos / diena
Kliento paskyra	60	5.000
Išplėstas limitas	pagal užklausą	pagal užklausą

Viršijus grąžinama HTTP 429 Too Many Requests grąžinama. Antraštė Retry-After nurodo laukimo laiką sekundėmis.

Klaidų kodai

HTTP-Code	Reikšmė
`200 OK`	Užklausa sėkminga
`400 Bad Request`	Netinkami parametrai
`401 Unauthorized`	Trūkstamas arba netinkamas API-Key
`403 Forbidden`	Nėra teisės šiam ištekliui
`404 Not Found`	Išteklius nerastas
`429 Too Many Requests`	Rate Limit viršytas
`500 Internal Server Error`	Serverio klaida – susisiekite su pagalba

Klaidos Response formatas

JSON

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

Endpoint: Užsakymai

GET /api/v1/orders Visi paskyros užsakymai

Parameter	Tipas	Aprašymas
`page`	integer	Puslapis (numatytasis: 1)
`per_page`	integer	Įrašai per puslapį (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} Gauti atskirą užsakymą

Endpoint: Produktų ir užsakymų informacija

GET /api/v1/orders/{order_id}/codes Visa užsakymo produktų informacija

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} Gauti atskirą produkto informaciją

warning Produktų ir užsakymų informacija gali būti naudojama tik atitinkamo užsakymo ir pardavėjo duomenų ribose. Piktnaudžiaujantis perdavimas gali pažeisti naudojimo sąlygas.

Endpoint: Produktai

GET /api/v1/products Gauti produktų katalogą

Parameter	Tipas	Aprašymas
`category`	string	Filtruoti pagal kategorijos slug
`in_stock`	boolean	Tik prieinami produktai
`page`	integer	Puslapis

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 leidžia gauti pranešimus realiu laiku, kai pateikiami užsakymai arba kodai. Webhook URL galima įvesti kliento paskyroje.

Prieinami įvykiai

Event	Aprašymas
`order.paid`	Užsakymas buvo apmokėtas
`codes.delivered`	Kodai buvo pateikti
`order.refunded`	Užsakymas buvo grąžintas

Webhook Payload

POST – Jūsų Webhook endpoint

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

Patikrinkite parašą su savo Webhook secret: HMAC-SHA256(payload, webhook_secret)

Dažni klausimai

Kas gali naudotis B2B API?

Kiekvienas klientas su kliento paskyra gali naudotis API prieiga. Prisijunkite prie savo kliento paskyros ir naudokite atitinkamą API-Key autentifikuotoms užklausoms.

Kokio formato yra atsakymai?

Visi atsakymai grąžinami kaip JSON. Šakninis objektas visada turi success: true/false taip pat arba data arba error.

Ar galiu pateikti užsakymus per API?

Pirmojoje versijoje API skirta užsakymų, užsakymų ir produktų informacijos gavimui. Rašymo užsakymų endpoints bus aktyvuoti atskirai, kai tik jie taps prieinami.

Ar yra Sandbox aplinka?

Taip. Sandbox galima aktyvuoti kliento paskyroje skirtuke „API prieiga“ ir ji tiesiogiai susieta su atitinkamu API-Key.