Získání API klíče
Přihlaste se ke svému účtu SmsManager a přejděte na stránku API & Cloud. Váš hlavní API klíč je tam zobrazen. Zkopírujte jej a uložte na bezpečné místo — použijete jej v každém požadavku na API.Předávání API klíče
Pomocí hlavičky (doporučeno)
Zahrňte svůj API klíč do hlavičky požadavkux-api-key. Tato metoda je podporována na všech endpointech JSON API v2 i REST API.
Pomocí query parametru (pouze simple endpoint)
Na endpointuGET /simple/message se můžete autentizovat připojením klíče jako query parametru apikey místo použití hlavičky.
Query parametr
apikey je podporován pouze na endpointu GET /simple/message. Všechny ostatní endpointy vyžadují hlavičku x-api-key.Správa API klíčů
Sub-klíče můžete programově vytvářet a spravovat přes REST API. Sub-klíče jsou užitečné, pokud provozujete více integrací nebo služeb a chcete sledovat využití nebo nezávisle odvolávat přístup. Při vytváření sub-klíče můžete nastavit:note— čitelný popisek, abyste snadno identifikovali, která integrace používá který klíčdefault_callback_url— záložní webhook URL použitá pro všechny zprávy odeslané tímto klíčem, pokud není zadán per-requestcallbackshared— nastavte natruepro sdílení kreditu s nadřazeným účtem nebo nafalsepro samostatný kredit sub-klíčecurrency— fakturační měna sub-klíče (EURneboCZK; musí odpovídat nadřazenému, pokudsharedjetrue)
API klíče jsou vázány na účet. Sub-klíče vytvořené pod vaším účtem mohou sdílet vaši kreditní linku nebo mít vlastní zůstatek podle toho, jak nastavíte příznak
shared při volání REST API.Bezpečnostní doporučení
Dodržujte tato doporučení pro ochranu vašich API klíčů a dat uživatelů:- Nikdy nezakódujte API klíče do klientského kódu — klíče v prohlížečovém JavaScriptu, mobilních aplikacích nebo veřejných repozitářích mohou být extrahovány a zneužity
- Používejte proměnné prostředí — načítejte klíče z proměnných prostředí nebo správce tajemství (např. AWS Secrets Manager, HashiCorp Vault), nekomitujte je do zdrojové kontroly
- Rotujte klíče při kompromitaci — pokud se domníváte, že klíč unikl, ihned vytvořte nový přes app.smsmanager.com/api-cloud nebo REST API, aktualizujte integrace a starý klíč smažte
- Používejte sub-klíče pro každou integraci — přiřaďte vyhrazený sub-klíč každé službě nebo prostředí (produkce, staging atd.), abyste mohli odvolat jediný klíč, aniž byste narušili vše ostatní
Chyby autentizace
Pokud váš API klíč chybí, je poškozený nebo není autorizován pro požadovanou operaci, API vrátí HTTP odpověď400.