Rocketoo MAX REST API

API podpora pro vývojáře

Vše, co potřebujete pro hladkou integraci s Rocketoo MAX. Aktuální dokumentace, přímý kontakt na vývojářský tým a odpovědi na otázky, na které vývojáři narážejí nejčastěji.

Na této stránce najdete tři věci. Odkaz na živou OpenAPI dokumentaci konkrétního e-shopu, kontakt na technickou podporu a vývojářskou znalostní bázi s nejčastějšími tématy. Pokud integrujete poprvé, doporučujeme začít od prvního bodu a teprve potom směřovat dotazy na podporu.

Materiály pro integraci

Dokumentace API

Každý e-shop Rocketoo MAX má vlastní URL pro API i pro jeho dokumentaci. Adresu najdete v administraci konkrétního e-shopu v sekci nastavení.

Interaktivní Swagger UI

Otevřete v prohlížeči adresu https://<vase-domena>/api/v1/docs. Najdete tam kompletní seznam endpointů, parametrů, ukázky požadavků i odpovědí a možnost testovat volání přímo v prohlížeči. Stačí zadat API klíč a poslat první požadavek.

OpenAPI specifikace ke stažení

Strojově čitelnou specifikaci ve formátu YAML stáhnete z https://<vase-domena>/api/v1/openapi.yaml. Použijte ji v generátorech klientského kódu — třeba v openapi-generator, Swagger Codegen nebo NSwag — a získáte typovaného klienta pro váš jazyk během minut.

Konvence API

API běží na URL začínající /api/v1, autentizace probíhá hlavičkou x-api-key, požadavky musí mít Content-Type: application/json, kódování je UTF-8. Odpovědi se vrací jako JSON, stejně jako chyby s textem zprávy a odpovídajícím HTTP status kódem.

Podpora

Kontakt na API podporu

Pro technické dotazy související s API, integracemi a vývojářskou prací máme dedikovaný kontakt.

E-mail: api@rocketoo.cz

Posílejte sem dotazy ohledně chování endpointů, neočekávaných odpovědí, autentizace, oprávnění, rate limitingu nebo verzování API. Pokud reportujete chybu, přidejte HTTP metodu, URL volání, hlavičky bez API klíče, tělo požadavku, status kód a tělo odpovědi. Čím přesnější popis, tím rychlejší odpověď.

Na e-maily reagujeme v pracovní dny během několika hodin. Kritické chyby v produkčním provozu řešíme přednostně — uveďte to v předmětu zprávy.

FAQ

Než napíšete na podporu

Odpovědi níže pokrývají většinu situací, se kterými se vývojáři při integraci potkávají.

Autentizace a API klíče

API klíč generujete v administraci e-shopu v sekci uživatelů API. Pro každou integraci vytvořte vlastní účet — usnadní to správu oprávnění a případné odebrání přístupu. Klíč posíláte v hlavičce x-api-key. Při chybné autentizaci API vrací status 401, při chybějícím oprávnění 403.

Oprávnění endpointů

Pro každý API účet konfigurujete přístup k jednotlivým endpointům a HTTP metodám. Pokud volání vrací 403, zkontrolujte, zda má účet povolený konkrétní endpoint i metodu (GET, POST, PUT, DELETE).

Stránkování výpisů

Většina GET endpointů vrací paginovaný výpis. Aktuální stránku ovládáte parametrem page, odpověď obsahuje pole s current_page, current_page_items, total_pages a total_items. Pro stažení velkého objemu dat procházejte stránky postupně a respektujte rate limit.

Filtrace dat

Endpointy podporují filtraci podle ID, e-mailu, dat vytvoření a aktualizace, aktivního stavu a dalších parametrů — viz dokumentace konkrétního endpointu. Pro inkrementální synchronizaci využijte updated_at_from a stahujte jen změny od posledního běhu.

Rate limiting

Při překročení limitu API vrací status 429 Too Many Requests. Integrace musí zachytit tento stav, počkat a volání opakovat. Pro hromadné operace s velkým počtem položek používejte bulk endpointy — třeba /variant/bulk pro hromadnou aktualizaci variant.

Nahrávání souborů a obrázků

Pro nahrání obrázku produktu, souboru produktu nebo souboru k objednávce použijte odpovídající endpointy s multipart/form-data. Standardní JSON Content-Type se na tyto požadavky neuplatňuje.

Chybové stavy

• 400 - API není aktivní v administraci e-shopu
• 401 - chybí autentizační hlavička x-api-key
• 403 - neplatný klíč nebo nedostatečná oprávnění
• 404 - neplatná URL požadavku
• 429 - překročen limit požadavků
• 500 - chyba na straně serveru, kontaktujte podporu

Healthcheck a monitoring

Endpoint /healthcheck slouží pro ověření dostupnosti API. Volejte ho periodicky z monitoringu vaší integrace a reagujte na výpadky. Endpoint /endpoint vrací seznam endpointů, ke kterým má váš API účet přístup — užitečné pro automatické sestavení klienta.

Verzování

Aktuální verze API běží pod cestou /api/v1. Případná nová verze poběží paralelně pod novou cestou. O změnách budeme informovat s dostatečným předstihem.

Něco chybí?

Pokud v dokumentaci nebo na této stránce nenajdete to, co potřebujete, napište nám. Stránku aktualizujeme podle reálných dotazů od vývojářů — váš dotaz pomůže i ostatním.

Napište nám na
api@rocketoo.cz

Zadejte své údaje, my se vám ozveme a rádi s vámi probereme vaše potřeby a otázky.

Jste agentura zastupující klienta?

Odesláním tohoto formuláře souhlasíte s přijímáním propagačních e-mailů od společnosti Digital Wizards Group s.r.o. týkajících se jejích produktů a služeb. Můžete se kdykoli odhlásit kliknutím na odkaz v dolní části našich e-mailů.