Open API

1. Spôsoby autentizácie

API mPOHODA podporuje dva spôsoby autentizácie, a to prostredníctvom:

• API kľúča

• prístupového tokenu

Z hľadiska väčšej bezpečnosti odporúčame používať prístup pomocou prístupového tokenu.

Vytvorenie API kľúča

Nový API kľúč vytvoríte cez tlačidlo Nový kľúč. Po kliknutí na tlačidlo je potrebné zadať názov API kľúča, ktorým môže byť napríklad vaše interné pomenovanie systému, s ktorým budete komunikovať s API mPOHODA. Názov potvrdíte tlačidlom Vytvoriť. Následne sa kľúč zobrazí v dialógovom okne.

Vygenerovaný API kľúč je tajný údaj, ktorú je potrebné uložiť na bezpečnom mieste mimo aplikáciu mPOHODA.

API kľúč, ktorý už nebudete potrebovať, je možné zmazať prostredníctvom ikony krížik, na konci riadku v zozname API kľúčov.

Vytvorenie prístupového tokenu

Pre získanie nového prístupového tokena je potrebné vytvoriť nového klienta, ktorého vytvoríte cez tlačidlo Nový klient. Po kliknutí na tlačidlo je potrebné zadať názov klienta, ktorým môže byť napríklad vaše interné pomenovanie systému, s ktorým budete komunikovať s API mPOHODA. Názov potvrdíte tlačidlom Vytvoriť. Následne sa zobrazí dialógové okno, v ktorom sa zobrazia dva údaje: Client Id a Client Secret. Client Secret nie je z bezpečnostných dôvodov v otvorenej podobe nikde uložený a nebude ho možné znovu zobraziť.

V prípade údaja Client Secret sa jedná o tajnú informáciu, ktorú je potrebné uložiť na bezpečnom mieste mimo aplikáciu mPOHODA.

Klienta, ktorého už nebudete potrebovať, je možné zmazať prostredníctvom ikony krížik, na konci riadku v zozname klientov.

2. Limity požiadaviek

Počet požiadaviek na API mPOHODA je limitovaný. Základný počet požiadaviek pre verziu mPOHODA Pro je 8000 požiadaviek za 1 mesiac. V prípade rozšírenia mCAL je to ďalších 8000 požiadaviek za každé rozšírenie mCAL.

Stav limitov sa zobrazuje v hlavičke každej odpovede z API a tiež v agende API, vo webovej aplikácii mPOHODA.

3. Dokumentácia

Dokumentácia k mPOHODA Open API slúži ako návod pre prácu s Open API.

Odkaz na podrobnú dokumentáciu k mPOHODA REST API.

Odkaz na dokumentáciu k Open API nájdete aj priamo v agende Open API (naľavo hore).

V dokumentácii nájdete:

• Ako začať - v tejto časti nájdete zoznam krokov, ktoré potrebujete ku komunikácii s API.

• Všeobecné - v tejto časti sa zoznámite so základnými informáciami týkajúcimi sa základných bezpečnostných opatrení, spôsobu autentizácie, základnej štruktúry odpovedí a chybových kódov.

• Referencie - v tejto časti nájdete podrobný popis jednotlivých API metód.

• Sprievodca - v tejto časti zistíte, ako použitím jednotlivých API metód vygenerovať v aplikácii mPOHODA rôzne typy záznamov.

• Podpora - v tejto časti nájdete kontakty na Zákaznícku podporu a taktiež FAQ - často kladené otázky.

mPOHODA API je dostupné len pre firmy s variantom mPOHODA Pro .

Späť na začiatok

Stiahnite si program TeamViewer a spojte sa s nami priamo.