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)

BereichSandbox
Globalresponse_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.
WebhooksSandbox-Bestellungen senden keine Webhooks.

Designziele

ZielBedeutung
WiederholbarGleiche Anfrage → gleiche Antwort (keine Zufälligkeit in Ergebnissen).
DokumentiertJedes Szenario hat eine stabile ID oder ein Keyword zum Suchen auf dieser Seite.
VertragskonformJSON entspricht standard-Schemafeldern aus Production; Werte unterscheiden sich.
Happy Path StandardUnbekannte IDs fallen auf generische Erfolgs-Mocks zurück.
Expliziter FehlerVerwenden Sie sb_*-IDs oder sandbox_trigger für erzwungene Fehler / Grenzzustände.

Benennung: sb_{domain}_{scenario}

SegmentRegelBeispiele
PräfixImmer sb_sb_prod_not_found
domainSubstantiv in Kleinbuchstaben (prod, search, ord, plat, auth, …)
scenariosnake_casenot_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 idErgebnisHTTP
(jede Nicht-sb_-ID)Standard-Mock-Produkt200
sb_prod_not_foundNOT_FOUND404
sb_prod_offlinePRODUCT_UNAVAILABLE422
sb_prod_no_stockDetail ok, stock: 0200
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 TextMock-Liste mit Treffern
sb_search_emptyitems: [], total: 0
sb_search_not_foundAlias für leer

Parse / upload-image / search-by-image / freight / analytics

EndpointSandbox-Hinweis
Parse URLURL-Query/Pfad mit sb_* spiegelt Detail-Verhalten.
Upload imageImmer { "image_id": "img_sandbox_mock" } nach bestandener Validierung.
Image searchOptionales keyword: sb_search_empty liefert leere Liste; mit upload-image für Flow-Tests kombinieren.
Advanced — freight estimateStandard-Inlandsfracht-Mock 800 Minor Units, abgestimmt mit Preview.
Advanced — batch-checkLiefert Upstream-Style-Envelope mit Mock mpProducts; sb_prod_not_found in mi_id/item_id für Ausschlusslisten.
Advanced — top keywords/list / daily-sales-trendsb_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_idTypischer statusHinweise
sb_ord_unpaidwait_payment
sb_ord_paidwait_shipment
sb_ord_shippedwait_receive
sb_ord_completedcompleted
sb_ord_cancelledcancelled
sb_ord_refundingwait_shipment (refund_status in progress)
sb_ord_not_found404

POST /v1/orders/pay

order_idErgebnisHTTP
sb_ord_unpaidZahlung erfolgreich → logischer Paid-Zustand200
sb_ord_pay_declinedPAYMENT_DECLINED402
sb_ord_pay_insufficientPAYMENT_INSUFFICIENT_FUNDS402
sb_ord_paidORDER_ALREADY_PAID409
sb_ord_cancelledORDER_CANCELLED409
sb_ord_upstream_timeoutCHANNEL_UPSTREAM_ERROR502

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_triggerHTTPerror.code
sb_plat_quota_exceeded429QUOTA_EXCEEDED
sb_plat_rate_limited429RATE_LIMIT_EXCEEDED
sb_plat_upstream_error502CHANNEL_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)

PhaseAbdeckungHinweise
ShippedProduct + Procurement APIs obenSpiegelt Public-API-Teilmenge auf dieser Site.
Not yetVollständiges /v1/fulfillment/*, Webhooks, unveröffentlichte OpenAPI-only-RoutenNicht 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_EXCEEDED

Beim internen Hinzufügen von Fixtures dieses Nummerierungsschema in Regressionstests spiegeln — niemals standard-JSON-Formen in Mocks verändern.