REST API: ověření klíče
Referenční popis ověřovací cesty REST API: co vrací, jaké chyby může poslat a jak jejím voláním ověřit klíč dřív, než postavíte integraci.
Jediná cesta, které stačí platný klíč bez jakéhokoli oprávnění. Hodí se jako první volání každé nové integrace.
Cesty odpovídají na GET na doméně vašeho obchodu, například https://muj-eshop.cz/api/v1/…, a klíč se posílá v hlavičce Authorization: Bearer nebo x-api-key. Parametry, pole i chyby na téhle stránce se generují ze smlouvy, podle které API odpovídá, takže platí pro build, na kterém stránka běží. Každá cesta může navíc vrátit chyby společné všem cestám: invalid_api_key, missing_api_key, external_access_disabled, external_access_not_enabled, external_access_suspended, key_surface_mismatch, plan_required, shop_unavailable, shop_not_found, rate_limited a server_error. Co znamenají, popisuje článek Chybové odpovědi, klíč a oprávnění Autentizace a oprávnění a průchod výpisem Stránkování a filtry.
GET /api/v1/ping
Ověření klíče, než postavíte scénář: vrátí jen identitu klíče a jeho oprávnění, žádná data obchodu. Stačí mu libovolný platný klíč, takže rozliší neplatný klíč od chybějícího oprávnění.
- Oprávnění: žádné, stačí libovolný platný klíč.
- Odpověď: objekt bez obálky.
curl -s https://muj-eshop.cz/api/v1/ping \
-H "Authorization: Bearer $SHOPZI_API_KEY"Pole odpovědi
ok(true)key_id(UUID)scopes(pole, položka: text): Oprávnění klíče.api_version(v1)
Chyby této cesty
Cesta nevrací žádnou chybu navíc ke společným chybám uvedeným v úvodu stránky.