Nic nenalezeno

Administrace API

Kde API spravuji?

Všechna rozhraní se spravují v BulkGate Portálu v sekci Moduly a API. Obrazovka má dvě části:

  • Moje API a Moduly — karty už vytvořených rozhraní. Kliknutím na kartu otevřete detail.
  • Objevte naše API a Moduly — katalog všeho, co si můžete založit. Kliknutím na dlaždici se otevře okno s popisem, odkazem na Webová stránka a Dokumentace a s formulářem pro vytvoření.

Sekce Moduly a API v portálu s částmi Moje API a Moduly a Objevte naše API a Moduly

Jak vytvořím nové API?

  1. V menu klikněte na Moduly a API
  2. V části Objevte naše API a Moduly klikněte na dlaždici rozhraní, které chcete založit
  3. Vyplňte formulář v okně, které se otevře
  4. Klikněte na Vytvořit API

Okno s formulářem pro vytvoření HTTP Simple API

Formulář se liší podle typu rozhraní:

Typ Pole ve formuláři
HTTP API a moduly s tokenem Jméno a Maximální počet zpráv API za den
Email > SMS a Low Level API Peněženka a Jméno
Moduly ke stažení bez formuláře, jen tlačítko Získejte modul
Poznámka

U HTTP API je Maximální počet zpráv API za den povinný — dokud ho nevyplníte, tlačítko Vytvořit API zůstane nedostupné.

Po vytvoření se dostanete do detailu. U Email > SMS v něm najdete v části Nastavení emailu údaje pro odesílání: Příjemce, Předmět pro krátkou SMS a Předmět pro dlouhou SMS.

Co je Application ID?

Application ID (APPLICATION_ID) je jedinečné číslo vaší aplikace. Spolu s Application tokenem (APPLICATION_TOKEN) tvoří přístupové údaje k API.

V detailu aplikace je uvedené hned pod jejím názvem ve tvaru #39238 a znovu v části Přihlašovací údaje.

Kde najdu přihlašovací údaje?

  1. V menu klikněte na Moduly a API
  2. V části Moje API a Moduly klikněte na kartu své aplikace
  3. Zůstaňte na kartě Nastavení a najděte část Přihlašovací údaje

Část Přihlašovací údaje v detailu aplikace s Application ID a tokenem

Je tu Application ID a seznam tokenů. Token se z bezpečnostních důvodů nezobrazuje rovnou — přes Zobrazit token si o něj musíte říct a potvrdit heslem. Stejně chráněné jsou i Přidat token a Obnovit token. Podrobnosti popisuje stránka API tokeny.

Jak API zapnu nebo vypnu?

  1. Otevřete detail aplikace
  2. Pod názvem aplikace je tlačítko s aktuálním stavem — Aktivní, nebo Zakázáno
  3. Rozbalte ho a zvolte Povolit, nebo Zakázat
  4. Volbu potvrďte v okně Změnit stav
Upozornění

Zakázané API odmítne každý požadavek. Zapnuté naopak každý požadavek přijme.

Jak API přejmenuji nebo smažu?

V pravém horním rohu detailu je tlačítko Přejmenovat. Otevře okno s polem Jméno; změnu potvrdíte opět tlačítkem Přejmenovat.

Šipka vedle něj rozbalí nabídku s položkou Smazat.

Pozor

Smazání aplikace je nevratné a odstraní i všechny tokeny, které k ní patří.

Jak nastavím potvrzení o doručení?

V detailu aplikace je na kartě Nastavení část Web hooky s dlaždicí Potvrzení o doručení. Zadáte do ní adresu, na kterou vám BulkGate bude hlásit stav odeslaných zpráv a doručovat příchozí odpovědi.

Celý postup i jednotlivé volby popisuje stránka Webhooky.

Byla tato stránka užitečná?