Rocketoo MAX REST API

API podpora pre vývojárov

Všetko, čo potrebujete pre hladkú integráciu s Rocketoo MAX. Aktuálna dokumentácia, priamy kontakt na vývojársky tím a odpovede na otázky, na ktoré vývojári narážajú najčastejšie.

Na tejto stránke nájdete tri veci. Odkaz na živú OpenAPI dokumentáciu konkrétneho e-shopu, kontakt na technickú podporu a vývojársku znalostnú bázu s najčastejšími témami. Ak integrujete prvýkrát, odporúčame začať od prvého bodu a až potom smerovať otázky na podporu.

Materiály pre integráciu

Dokumentácia API

Každý e-shop Rocketoo MAX má vlastnú URL pre API aj pre jeho dokumentáciu. Adresu nájdete v administrácii konkrétneho e-shopu v sekcii nastavení.

Interaktívne Swagger UI

Otvorte v prehliadači adresu https://<vasa-domena>/api/v1/docs. Nájdete tam kompletný zoznam endpointov, parametrov, ukážky požiadaviek aj odpovedí a možnosť testovať volania priamo v prehliadači. Stačí zadať API kľúč a poslať prvú požiadavku.

OpenAPI špecifikácia na stiahnutie

Strojovo čitateľnú špecifikáciu vo formáte YAML stiahnete z https://<vasa-domena>/api/v1/openapi.yaml. Použite ju v generátoroch klientskeho kódu — napríklad v openapi-generator, Swagger Codegen alebo NSwag — a získate typovaného klienta pre váš jazyk počas minút.

Konvencie API

API beží na URL začínajúcej /api/v1, autentizácia prebieha hlavičkou x-api-key, požiadavky musia mať Content-Type: application/json, kódovanie je UTF-8. Odpovede sa vracajú ako JSON, rovnako ako chyby s textom správy a zodpovedajúcim HTTP status kódom.

Podpora

Kontakt na API podporu

Pre technické otázky súvisiace s API, integráciami a vývojárskou prácou máme dedikovaný kontakt.

E-mail: api@rocketoo.cz

Posielajte sem otázky ohľadom správania endpointov, neočakávaných odpovedí, autentizácie, oprávnení, rate limitingu alebo verzovania API. Ak reportujete chybu, pridajte HTTP metódu, URL volania, hlavičky bez API kľúča, telo požiadavky, status kód a telo odpovede. Čím presnejší popis, tým rýchlejšia odpoveď.

Na e-maily reagujeme v pracovných dňoch počas niekoľkých hodín. Kritické chyby v produkčnej prevádzke riešime prednostne — uveďte to v predmete správy.

FAQ

Skôr ako napíšete na podporu

Odpovede nižšie pokrývajú väčšinu situácií, s ktorými sa vývojári pri integrácii stretávajú.

Autentizácia a API kľúče

API kľúč generujete v administrácii e-shopu v sekcii používateľov API. Pre každú integráciu vytvorte vlastný účet — uľahčí to správu oprávnení a prípadné odobratie prístupu. Kľúč posielate v hlavičke x-api-key. Pri chybnej autentizácii API vracia status 401, pri chýbajúcom oprávnení 403.

Oprávnenia endpointov

Pre každý API účet konfigurujete prístup k jednotlivým endpointom a HTTP metódam. Ak volanie vracia 403, skontrolujte, či má účet povolený konkrétny endpoint aj metódu (GET, POST, PUT, DELETE).

Stránkovanie výpisov

Väčšina GET endpointov vracia paginovaný výpis. Aktuálnu stránku ovládate parametrom page, odpoveď obsahuje pole s current_page, current_page_items, total_pages a total_items. Pre stiahnutie veľkého objemu dát prechádzajte stránky postupne a rešpektujte rate limit.

Filtrácia dát

Endpointy podporujú filtráciu podľa ID, e-mailu, dátumov vytvorenia a aktualizácie, aktívneho stavu a ďalších parametrov — pozri dokumentáciu konkrétneho endpointu. Pre inkrementálnu synchronizáciu využite updated_at_from a sťahujte iba zmeny od posledného behu.

Rate limiting

Pri prekročení limitu API vracia status 429 Too Many Requests. Integrácia musí zachytiť tento stav, počkať a volanie opakovať. Pre hromadné operácie s veľkým počtom položiek používajte bulk endpointy — napríklad /variant/bulk pre hromadnú aktualizáciu variantov.

Nahrávanie súborov a obrázkov

Pre nahranie obrázka produktu, súboru produktu alebo súboru k objednávke použite zodpovedajúce endpointy s multipart/form-data. Štandardný JSON Content-Type sa na tieto požiadavky neuplatňuje.

Chybové stavy

• 400 - API nie je aktívne v administrácii e-shopu
• 401 - chýba autentizačná hlavička x-api-key
• 403 - neplatný kľúč alebo nedostatočné oprávnenia
• 404 - neplatná URL požiadavky
• 429 - prekročený limit požiadaviek
• 500 - chyba na strane servera, kontaktujte podporu

Healthcheck a monitoring

Endpoint /healthcheck slúži na overenie dostupnosti API. Volajte ho periodicky z monitoringu vašej integrácie a reagujte na výpadky. Endpoint /endpoint vracia zoznam endpointov, ku ktorým má váš API účet prístup — užitočné pre automatické zostavenie klienta.

Verzovanie

Aktuálna verzia API beží pod cestou /api/v1. Prípadná nová verzia pobeží paralelne pod novou cestou. O zmenách budeme informovať s dostatočným predstihom.

Niečo chýba?

Ak v dokumentácii alebo na tejto stránke nenájdete to, čo potrebujete, napíšte nám. Stránku aktualizujeme podľa reálnych otázok od vývojárov — vaša otázka pomôže aj ostatným.

Napíšte nám na
api@rocketoo.cz

Zadajte svoje údaje, my sa vám ozveme a radi s vami preberieme vaše potreby a otázky.

Ste agentúra zastupujúca klienta?

Odoslaním tohto formulára súhlasíte s prijímaním propagačných e-mailov od spoločnosti Digital Wizards Group s.r.o. týkajúcich sa jej produktov a služieb. Môžete sa kedykoľvek odhlásiť kliknutím na odkaz v dolnej časti našich e-mailov.