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.
Format nagłówka
X-API-Key: YOUR_API_KEY_HERE Content-Type: application/json Accept: application/json
Przykład z 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:
https://artumos.com/api/v1
Wszystkie odpowiedzi są zwracane jako JSON zwracane (Content-Type: application/json).
Rate Limits
| Plan | Zapytania / minuta | Zapytania / dzień |
|---|---|---|
| Konto klienta | 60 | 5.000 |
| Rozszerzony limit | na życzenie | na życzenie |
Przy przekroczeniu zwracane jest HTTP 429 Too Many Requests . Nagłówek Retry-After zawiera czas oczekiwania w sekundach.
Kody błędów
| HTTP-Code | Znaczenie |
|---|---|
200 OK | Zapytanie zakończone sukcesem |
400 Bad Request | Nieprawidłowe parametry |
401 Unauthorized | Brakujący lub nieprawidłowy API-Key |
403 Forbidden | Brak uprawnień do tego zasobu |
404 Not Found | Zasób nie znaleziony |
429 Too Many Requests | Rate Limit przekroczony |
500 Internal Server Error | Błąd serwera – skontaktuj się ze wsparciem |
Format Response błędu
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key."
}
}
Endpoint: Zamówienia
/api/v1/orders
Wszystkie zamówienia konta
| Parameter | Typ | Opis |
|---|---|---|
page | integer | Strona (domyślnie: 1) |
per_page | integer | Wpisy na stronę (maks. 100) |
status | string | paid | pending | all |
{
"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
}
}
}
/api/v1/orders/{order_id}
Pobierz pojedyncze zamówienie
Endpoint: Informacje o produkcie i zamówieniu
/api/v1/orders/{order_id}/codes
Wszystkie informacje o produkcie dla zamówienia
{
"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"
}
]
}
}
/api/v1/codes/{code_id}
Pobierz pojedynczą informację o produkcie
Endpoint: Produkty
/api/v1/products
Pobierz katalog produktów
| Parameter | Typ | Opis |
|---|---|---|
category | string | Filtruj po slug kategorii |
in_stock | boolean | Tylko dostępne produkty |
page | integer | Strona |
{
"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
| Event | Opis |
|---|---|
order.paid | Zamówienie zostało opłacone |
codes.delivered | Kody zostały udostępnione |
order.refunded | Zamówienie zostało zwrócone |
Webhook Payload
{
"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
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ń.
Wszystkie odpowiedzi są zwracane jako JSON. Obiekt główny zawsze zawiera success: true/false oraz albo data albo error.
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.
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.