B2B dokumentace

B2B API – automatizované získávání informací o objednávkách a produktech

Naše REST API je k dispozici každému zákazníkovi se zákaznickým účtem a umožňuje automatizovaně získávat informace o objednávkách a produktech a integrovat je do vlastních systémů.

vpn_key Otevřít přístup k API v účtu Stránka pro firemní zákazníky

Autentizace

Všechny API požadavky vyžadují platný API-Key, který se odesílá v HTTP hlavičce. Přístup k API je vázán na váš zákaznický účet a je v zásadě k dispozici zákaznickým účtům.

info Nepotřebujete žádnou samostatnou B2B žádost: přihlaste se svým zákaznickým účtem, otevřete záložku API a vygenerujte si tam svůj API-Key. K přístupu k API →

Formát hlavičky

HTTP Request Header

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

Příklad s 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

Všechny endpointy jsou relativní k následující Base URL:

Base URL

https://artumos.com/api/v1

Všechny odpovědi jsou vráceny jako JSON (Content-Type: application/json).

Rate Limits

Plan	Požadavky / minutu	Požadavky / den
Zákaznický účet	60	5.000
Rozšířený limit	na vyžádání	na vyžádání

Při překročení je vráceno HTTP 429 Too Many Requests . Hlavička Retry-After obsahuje dobu čekání v sekundách.

Chybové kódy

HTTP-Code	Význam
`200 OK`	Požadavek úspěšný
`400 Bad Request`	Neplatné parametry
`401 Unauthorized`	Chybějící nebo neplatný API-Key
`403 Forbidden`	Žádné oprávnění pro tento zdroj
`404 Not Found`	Zdroj nenalezen
`429 Too Many Requests`	Rate Limit překročen
`500 Internal Server Error`	Chyba serveru – kontaktujte prosím podporu

Formát chybové odpovědi

JSON

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

Endpoint: Objednávky

GET /api/v1/orders Všechny objednávky účtu

Parameter	Typ	Popis
`page`	integer	Stránka (výchozí: 1)
`per_page`	integer	Položky na stránku (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} Získat jednotlivou objednávku

Endpoint: Informace o produktu a objednávce

GET /api/v1/orders/{order_id}/codes Všechny informace o produktu pro objednávku

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} Získat jednotlivou informaci o produktu

warning Informace o produktu a objednávce smějí být použity pouze v rámci příslušné objednávky a údajů prodejce. Zneužívající předávání může porušovat podmínky používání.

Endpoint: Produkty

GET /api/v1/products Získat katalog produktů

Parameter	Typ	Popis
`category`	string	Filtrovat podle slugu kategorie
`in_stock`	boolean	Pouze dostupné produkty
`page`	integer	Stránka

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

Webhooky umožňují přijímat oznámení v reálném čase, když jsou objednávky nebo kódy poskytnuty. Webhook URL lze uložit v zákaznickém účtu.

Dostupné Events

Event	Popis
`order.paid`	Objednávka byla zaplacena
`codes.delivered`	Kódy byly poskytnuty
`order.refunded`	Objednávka byla refundována

Webhook Payload

POST – Váš Webhook endpoint

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

Ověřte podpis svým Webhook secretem: HMAC-SHA256(payload, webhook_secret)

Časté dotazy

Kdo může používat B2B API?

Každý zákazník se zákaznickým účtem může používat přístup k API. Přihlaste se ke svému zákaznickému účtu a použijte příslušný API-Key pro autentizované požadavky.

Jaký formát mají odpovědi?

Všechny odpovědi jsou vráceny jako JSON. Root objekt obsahuje vždy success: true/false a buď data nebo error.

Mohu zadávat objednávky přes API?

V první verzi slouží API k získávání objednávek a informací o objednávkách a produktech. Zapisovací endpointy pro objednávky budou zpřístupněny samostatně, jakmile budou k dispozici.

Existuje Sandbox prostředí?

Ano. Sandbox lze aktivovat v zákaznickém účtu v záložce „Přístup k API“ a je přímo vázán na příslušný API-Key.