Open API

1. Způsoby autentizace

API mPOHODA podporuje dva způsoby autentizace, a to prostřednictvím:

• API klíče

• přístupového tokenu

Z hlediska vyšší bezpečnosti doporučujeme používat přístup pomocí přístupového tokenu.

Vytvoření API klíče

Nový API klíč vytvoříte pomocí tlačítka Nový klíč. Po kliknutí na tlačítko je nutné zadat název API klíče, kterým může být například vaše interní pojmenování systému, se kterým budete komunikovat s API mPOHODA. Název potvrdíte tlačítkem Vytvořit. Následně sa klíč zobrazí v dialogovém okně.

Vygenerovaný API klíč je tajný údaj, který je nutné uložit na bezpečném místě mimo aplikaci mPOHODA.

API klíč, který už nebudete potřebovat, je možné smazat prostřednictvím ikony křížku, na konci řádku v seznamu API klíčů.

Vytvoření přístupového tokenu

Pro získání nového přístupového tokenu je nutné zadat nového klienta, kterého vytvoříte pomocí tlačítka Nový klient. Po kliknutí na tlačítko je potřeba zadat název klienta, kterým může být například vaše interní pojmenování systému, se kterým budete komunikovat s API mPOHODA. Název potvrdíte tlačítkemVytvořit. Následně se zobrazí dialogové okno, ve kterém jsou uvedeny dva údaje: Client Id a Client Secret. Tyto údaje jsou potřebné pro vygenerování tokenu pro přístup na API mPOHODA.

V případě údaje Client Secret se jedná o tajnou informaci, kterou nebude možné nikdy znovu zobrazit, proto si ji uložte na bezpečném místě mimo aplikaci mPOHODA.

Klienta, kterého už nebudete potřebovat, je možné smazat prostřednictvím ikony křížku, na konci řádku v seznamu klientů.

2. Limity požadavků

Počet požadavků na API mPOHODA je limitován. Základní počet požadavků pro verzi mPOHODA Pro je 8000 požadavků za 1 měsíc. V případě rozšíření mCAL je to dalších 8000 požadavků za každé rozšíření mCAL.

Stav limitů se zobrazuje v hlavičce každé odpovědi z API a také v agendě API, ve webové aplikaci mPOHODA.

3. Dokumentace

Dokumentace k mPOHODA Open API slouží jako návod pro práci s Open API.

Odkaz na podrobnou dokumentaci k mPOHODA REST API.

Odkaz na dokumentaci k Open API najdete také přímo v agendě Open API (vlevo nahoře).

V dokumentaci najdete:

• Jak začít - v této části najdete seznam kroků, které potřebujete ke komunikaci s API.

• Všeobecné - v této části se seznámíte se základními informacemi týkající se základních bezpečnostních opatření, způsobu autentizace, základní struktury odpovědí a chybových kódů.

• Reference - v této části najdete podrobný popis jednotlivých API metod.

• Průvodce - v této části zjistíte, jak použitím jednotlivých API metod vygenerovat v aplikaci mPOHODA různé typy záznamů.

• Podpora - v této části najdete kontakty na Zákaznickou podporu a taktéž FAQ - často kladené otázky.

mPOHODA API je dostupné pouze ve variantě mPOHODA Pro .

Zpět na začátek

Stáhněte si program TeamViewer a spojte se s námi přímo.