K čemu je API potřeba
API (Application Programming Interface) — je funkcionalita pro interakci mezi různými programy. Pro člověka existují samostatná rozhraní, například web. API je potřeba pro různé integrace. Sender Solutions má API, které funguje pomocí HTTP požadavků ve formátu JSON. Přístup k API je poskytován pro všechny tarifní plány projektu, včetně bezplatného tarifního plánu. API Sender Solutions můžete používat pro úplnější a flexibilnější integraci. Předpokládaný formát používání API — z vašeho webu na základě triggerů. Například když se na vašem webu vytvoří odběratel, web provede API požadavek a odběratel se stejnými údaji se vytvoří v Sender Solutions.
Zahájení používání API
- Chcete-li používat API, musíte vytvořit projekt v Osobním účtu Sender Solutions.
- Dále na stránce nastavení projektu vytvořte API klíč. Je to jedinečný přístupový klíč k API na úrovni tohoto projektu. Uchovávejte jej v tajnosti. Pokud existuje podezření, že byl klíč kompromitován, začněte co nejrychleji používat nový klíč a kompromitovaný klíč deaktivujte nebo smažte.
- Pro jeden projekt lze vytvořit několik API klíčů — všechny jsou rovnocenné. To může být užitečné, pokud máte několik různých aplikací, které budou provádět API požadavky.
- API klíč je nutné předávat v HTTP záhlaví Authorization.
- Tělo požadavku předávejte ve formátu JSON a v záhlaví Content-Type uveďte hodnotu application/json.
- Orientujte se podle HTTP stavu odpovědi. Pokud je kód 200 — vše proběhlo úspěšně. Pokud je kód 500 — došlo k chybě.
- Odpověď z API se obecně vrací ve formátu JSON. Na kořenové úrovni je přítomen klíč "success" s možnými hodnotami true / false.
Příklad úspěšné odpovědi:{
"success": true
}
Příklad odpovědi s chybou:{
"error": "Some error description",
"success": false
}
V těle úspěšné odpovědi mohou být další údaje v závislosti na konkrétním požadavku. - Pro práci s API není potřeba podpora cookies nebo relací.
Užitečné zdroje
Composer balíček pro práci s API v php: sender-solutions/php-sdk a tentýž balíček na githubu: Sender-Solutions/php-sdk
Postman kolekce požadavků k API je dostupná na odkazu