Sandbox-Umgebung und Fixtures
Zielgruppe: Integrationen gegen
https://api.hiobuy.com(Workers-Gateway) — dieselbe Basis-URL wie in Production.
Auth: Deterministische Fixtures gelten nur für API-Schlüssel mit Präfix hio_test_* (key_type: test). hio_live_* Production-Schlüssel beachten nie die Regeln dieser Seite — sie rufen Upstream-Marktplätze stets normal auf.
Verwandte Docs: Authentication · Response format · Errors · Rate limits · Products · Orders · Webhooks
Public-API-Abdeckung (Überblick)
| Bereich | Sandbox |
|---|---|
| Global | response_format: upstream abgelehnt (nur standard). currency-Body-Feld abgelehnt wie in prod. sandbox_trigger erlaubt für Test-Schlüssel (Plattform-Fixtures). Channel-OAuth als autorisiert behandelt für hio_test_*. Quotas & Rate Limits übersprungen für Test-Schlüssel. |
/v1/products/* | Search, Detail, Parse, Upload-Image, Search-by-Image, Freight Estimate, Batch-Check, 1688-Analytics-Endpunkte gemockt wie unten dokumentiert. OpenAPI-only-Erweiterungen außerhalb des Handoff-Sets dieser Site nicht gemockt. |
/v1/orders/* | Preview, Create, Detail, Pay, Cancel, Logistics Trace, List, Purchase Query gemockt mit Magic-/Dynamic-IDs. |
/v1/fulfillment/* | Nicht gemockt im Gateway derzeit — in Sandbox als nicht verfügbar behandeln. |
| Webhooks | Sandbox-Bestellungen senden keine Webhooks. |
Designziele
| Ziel | Bedeutung |
|---|---|
| Wiederholbar | Gleiche Anfrage → gleiche Antwort (keine Zufälligkeit in Ergebnissen). |
| Dokumentiert | Jedes Szenario hat eine stabile ID oder ein Keyword zum Suchen auf dieser Seite. |
| Vertragskonform | JSON entspricht standard-Schemafeldern aus Production; Werte unterscheiden sich. |
| Happy Path Standard | Unbekannte IDs fallen auf generische Erfolgs-Mocks zurück. |
| Expliziter Fehler | Verwenden Sie sb_*-IDs oder sandbox_trigger für erzwungene Fehler / Grenzzustände. |
Benennung: sb_{domain}_{scenario}
| Segment | Regel | Beispiele |
|---|---|---|
| Präfix | Immer sb_ | sb_prod_not_found |
domain | Substantiv in Kleinbuchstaben (prod, search, ord, plat, auth, …) | — |
scenario | snake_case | not_found, pay_declined |
Zeichen: [a-z0-9_], Länge ≤ ~48. Nicht echte Upstream-IDs mit sb_ präfixen, es sei denn, Sie wollen die Fixture.
Zwei Fehlerschichten
Unterscheiden Sie Transport-/API-Fehler von HTTP-200-Geschäftszuständen:
- API-Fehler → HTTP 4xx/5xx +
error.code(z. B.NOT_FOUND,PAYMENT_DECLINED). - HTTP 200 mit Zustand → z. B.
variants[].stock = 0,status: wait_payment.
Produkt-Fixtures (Überblick)
POST /v1/products/detail
Siehe Product detail. Format upstream in Sandbox nicht unterstützt.
Auslöser, wenn product_id, geparste url, mi_id oder tao_password zu einer sb_*-ID aufgelöst wird.
| Fixture id | Ergebnis | HTTP |
|---|---|---|
(jede Nicht-sb_-ID) | Standard-Mock-Produkt | 200 |
sb_prod_not_found | NOT_FOUND | 404 |
sb_prod_offline | PRODUCT_UNAVAILABLE | 422 |
sb_prod_no_stock | Detail ok, stock: 0 | 200 |
curl https://api.hiobuy.com/v1/products/detail \
-H "Authorization: Bearer hio_test_..." \
-H "Content-Type: application/json" \
-d '{"channel":"1688","product_id":"sb_prod_not_found","language":"en"}'POST /v1/products/search
channel, keyword, page, page_size, language gelten. 1688 filter / sort / Preisfilter akzeptiert, aber für Mock-Zeilen ignoriert.
keyword (exakt) | Ergebnis |
|---|---|
| gewöhnlicher Text | Mock-Liste mit Treffern |
sb_search_empty | items: [], total: 0 |
sb_search_not_found | Alias für leer |
Parse / upload-image / search-by-image / freight / analytics
| Endpoint | Sandbox-Hinweis |
|---|---|
| Parse URL | URL-Query/Pfad mit sb_* spiegelt Detail-Verhalten. |
| Upload image | Immer { "image_id": "img_sandbox_mock" } nach bestandener Validierung. |
| Image search | Optionales keyword: sb_search_empty liefert leere Liste; mit upload-image für Flow-Tests kombinieren. |
| Advanced — freight estimate | Standard-Inlandsfracht-Mock 800 Minor Units, abgestimmt mit Preview. |
| Advanced — batch-check | Liefert Upstream-Style-Envelope mit Mock mpProducts; sb_prod_not_found in mi_id/item_id für Ausschlusslisten. |
| Advanced — top keywords/list / daily-sales-trend | sb_search_empty auf category_id / rank_id wo dokumentiert für leere Listen oder 404-Detail-Fälle. |
Bestell- und Zahlungs-Fixtures (Magic-IDs)
POST /v1/orders/detail
order_id | Typischer status | Hinweise |
|---|---|---|
sb_ord_unpaid | wait_payment | — |
sb_ord_paid | wait_shipment | — |
sb_ord_shipped | wait_receive | — |
sb_ord_completed | completed | — |
sb_ord_cancelled | cancelled | — |
sb_ord_refunding | wait_shipment (refund_status in progress) | — |
sb_ord_not_found | — | 404 |
POST /v1/orders/pay
order_id | Ergebnis | HTTP |
|---|---|---|
sb_ord_unpaid | Zahlung erfolgreich → logischer Paid-Zustand | 200 |
sb_ord_pay_declined | PAYMENT_DECLINED | 402 |
sb_ord_pay_insufficient | PAYMENT_INSUFFICIENT_FUNDS | 402 |
sb_ord_paid | ORDER_ALREADY_PAID | 409 |
sb_ord_cancelled | ORDER_CANCELLED | 409 |
sb_ord_upstream_timeout | CHANNEL_UPSTREAM_ERROR | 502 |
Preview / create
Preview liefert feste illustrative Summen (Beispielzeile ~4500 + Fracht ~800 in Minor Units). Create erzeugt dynamische order_id-Werte mit Präfix sbo_*, persistiert in Sandbox-Storage — Zeilen mit offer_id: sb_prod_offline / sb_prod_no_stock liefern 422 wie Production-Semantik.
Cancel / logistics / list / purchase query
Laut cancel, trace, detail list: unbezahlte sb_ord_* und dynamische unbezahlte sbo_* stornierbar; Paid/Shipped/etc.-Fixtures liefern ORDER_NOT_CANCELLABLE. Logistics liefert Packages für sb_ord_shipped / completed-Mocks; unpaid/paid-await-shipment liefern packages: []. Käuferliste respektiert product_name: sb_ord_list_empty für leere Mocks. Purchase query liefert Upstream-Envelopes; omitieren Sie entsprechend not-found-Pseudo-IDs.
Plattform-Trigger: sandbox_trigger
Nur auf hio_test_* erlaubt; Production-Schlüssel ignorieren das Feld still.
sandbox_trigger | HTTP | error.code |
|---|---|---|
sb_plat_quota_exceeded | 429 | QUOTA_EXCEEDED |
sb_plat_rate_limited | 429 | RATE_LIMIT_EXCEEDED |
sb_plat_upstream_error | 502 | CHANNEL_UPSTREAM_ERROR |
Mit harmlosen IDs kombinieren, damit realistische Bodies validieren:
{
"channel": "1688",
"product_id": "123456",
"language": "en",
"sandbox_trigger": "sb_plat_quota_exceeded"
}Spezielle Auth-Fixture sb_auth_channel_required mit Triggern kann CHANNEL_AUTH_REQUIRED (403) für UI-Regressionen erzeugen trotz der Regel „authorized by default“.
Implementierungsstatus (Snapshot)
| Phase | Abdeckung | Hinweise |
|---|---|---|
| Shipped | Product + Procurement APIs oben | Spiegelt Public-API-Teilmenge auf dieser Site. |
| Not yet | Vollständiges /v1/fulfillment/*, Webhooks, unveröffentlichte OpenAPI-only-Routen | Nicht in Sandbox-CI darauf verlassen, bis angekündigt. |
Kurz-Spickzettel
sb_prod_not_found → 404 product missing
sb_prod_offline → 422 unavailable
sb_prod_no_stock → 200 detail with zero stock
sb_search_empty → empty search/items
sb_ord_list_empty → empty buyer order list filter
img_sandbox_mock → stable upload-image id
sb_ord_unpaid → detail wait_payment • pay succeeds • cancel ok
sb_ord_pay_declined → pay 402 PAYMENT_DECLINED
sb_ord_paid → pay 409 ALREADY_PAID • trace maybe empty until shipped fixtures
sb_ord_shipped → detail wait_receive • trace populated
sb_ord_cancelled → cancelled state • pay conflicts
sb_plat_quota_exceeded → sandbox_trigger → 429 QUOTA_EXCEEDEDBeim internen Hinzufügen von Fixtures dieses Nummerierungsschema in Regressionstests spiegeln — niemals standard-JSON-Formen in Mocks verändern.