Dokumentacja B2B

API B2B – automatyczne pobieranie informacji o zamówieniach i produktach

Nasze REST API jest dostępne dla każdego klienta z kontem klienta i umożliwia automatyczne pobieranie informacji o zamówieniach i produktach oraz integrację z własnymi systemami.

Uwierzytelnianie

Wszystkie zapytania API wymagają ważnego API-Key, który jest przesyłany w nagłówku HTTP. Dostęp do API jest powiązany z Twoim kontem klienta i jest zasadniczo dostępny dla kont klientów.

info Nie potrzebujesz osobnego wniosku B2B: Zaloguj się na swoje konto klienta, otwórz zakładkę API i wygeneruj tam swój API-Key. Do dostępu do API →

Format nagłówka

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

Przykład z 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

Wszystkie endpointy są względne wobec następującego Base URL:

Base URL
https://artumos.com/api/v1

Wszystkie odpowiedzi są zwracane jako JSON zwracane (Content-Type: application/json).

Rate Limits

PlanZapytania / minutaZapytania / dzień
Konto klienta605.000
Rozszerzony limitna życzeniena życzenie

Przy przekroczeniu zwracane jest HTTP 429 Too Many Requests . Nagłówek Retry-After zawiera czas oczekiwania w sekundach.

Kody błędów

HTTP-CodeZnaczenie
200 OKZapytanie zakończone sukcesem
400 Bad RequestNieprawidłowe parametry
401 UnauthorizedBrakujący lub nieprawidłowy API-Key
403 ForbiddenBrak uprawnień do tego zasobu
404 Not FoundZasób nie znaleziony
429 Too Many RequestsRate Limit przekroczony
500 Internal Server ErrorBłąd serwera – skontaktuj się ze wsparciem

Format Response błędu

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

Endpoint: Zamówienia

GET /api/v1/orders Wszystkie zamówienia konta
ParameterTypOpis
pageintegerStrona (domyślnie: 1)
per_pageintegerWpisy na stronę (maks. 100)
statusstringpaid | 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} Pobierz pojedyncze zamówienie

Endpoint: Informacje o produkcie i zamówieniu

GET /api/v1/orders/{order_id}/codes Wszystkie informacje o produkcie dla zamówienia
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} Pobierz pojedynczą informację o produkcie
warning Informacje o produkcie i zamówieniu mogą być wykorzystywane wyłącznie w ramach danego zamówienia i informacji o sprzedawcy. Niewłaściwe udostępnianie może naruszać warunki użytkowania.

Endpoint: Produkty

GET /api/v1/products Pobierz katalog produktów
ParameterTypOpis
categorystringFiltruj po slug kategorii
in_stockbooleanTylko dostępne produkty
pageintegerStrona
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

Webhooki umożliwiają odbieranie powiadomień w czasie rzeczywistym, gdy zamówienia lub kody są udostępniane. Adresy URL Webhooków można zapisać na koncie klienta.

Dostępne Eventy

EventOpis
order.paidZamówienie zostało opłacone
codes.deliveredKody zostały udostępnione
order.refundedZamówienie zostało zwrócone

Webhook Payload

POST – Twój endpoint Webhook
{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

Zweryfikuj sygnaturę za pomocą swojego Webhook-Secret: HMAC-SHA256(payload, webhook_secret)

Częste pytania

Kto może korzystać z API B2B?

Każdy klient z kontem klienta może korzystać z dostępu do API. Zaloguj się na swoje konto klienta i użyj powiązanego API-Key do uwierzytelnionych zapytań.

Jaki format mają odpowiedzi?

Wszystkie odpowiedzi są zwracane jako JSON. Obiekt główny zawsze zawiera success: true/false oraz albo data albo error.

Czy mogę składać zamówienia przez API?

W pierwszej wersji API służy do pobierania zamówień oraz informacji o zamówieniach i produktach. Endpointy zapisujące zamówienia zostaną udostępnione osobno, gdy tylko będą dostępne.

Czy istnieje środowisko Sandbox?

Tak. Sandbox można aktywować na koncie klienta w zakładce „Dostęp do API” i jest bezpośrednio powiązany z danym API-Key.