Práce s API Fénix
API Fénix je RESTové rozhraní. Pro komunikaci využívá formát JSON a poskytuje veřejně dostupnou specifikaci OpenAPI (JSON).
Podporované metody API Fénix
- User – přístup k API a informace o uživateli (získání Access Tokenu).
- Nakupy – rozhraní pro správu Seznam Nákupů a provozoven
Na nejnižší úrovni je dostupný endpoint, který poskytuje metadata o API Fénix jako je verze, URL dokumentace nebo třeba kontakt na podporu.
Autentizace
Pro použití většiny metod API Fénix potřebujete Access Token. Ten získáte voláním endpointu /user/token s použitím Refresh Tokenu (API klíč). Následně jej uvádějte v hlavičce Authorization u volání těch metod, které to vyžadují.
Základní operace
API Fénix je RESTové API, takže endpointy se volají výhradně prostřednictvím HTTP metod:
- GET – čtení dat (např. přehledy/metadata).
- POST – vytvoření nového zdroje nebo akce (např. získání Access Tokenu).
- PATCH/PUT – úprava existujícího zdroje.
- DELETE – smazání zdroje.
Konkrétní dostupné metody pro každý endpoint jsou vždy uvedeny v dokumentaci.