Úvod a prístup k API

Vitajte v dokumentácii Beenia Application API Interface! Táto dokumentácia poskytuje podrobný prehľad verejného rozhrania API, ktoré vám umožňuje integrovať sa s našou platformou a získať prístup k rôznym funkciám a údajom.

‍

Úvod

Beenia Application API je navrhnuté tak, aby umožnilo externým vývojárom komunikovať s našou aplikáciou a využívať jej funkcie vo svojich vlastných aplikáciách alebo službách. Verejné rozhranie API ponúka možnosť načítať a aktualizovať údaje v našej platforme, spracovať transakcie a vykonávať ďalšie operácie, ktoré sú nevyhnutné pre vaše potreby.

Je dôležité poznamenať, že naša aplikácia obsahuje aj interné REST rozhrania určené na interné účely a nie sú verejne prístupné. Tieto interné rozhrania sú určené na interný vývoj a správu aplikácií a nie sú súčasťou tejto dokumentácie.

Prístup k rozhraniu API

Ak chcete získať prístup k verejnému rozhraniu API aplikácie Beenia, musíte použiť kľúč API. Tento kľúč vám umožňuje overiť sa a zabezpečiť, aby ste mohli podávať žiadosti do nášho rozhrania API. Kľúč API musí byť zahrnutý v hlavičke každej požiadavky REST pod parametrom X-KEY. Tento kľúč je jedinečný pre váš účet a používa sa na overenie vašej identity a autorizácie na používanie rozhrania API. Informácie o tom, ako získať kľúč API a ďalšie podrobnosti o autentifikácii nájdete na https://www.beenia.com/article/zapier-integration-for-beenia.

‍

API

Po získaní kľúča API môžete začať používať naše API na vykonávanie rôznych operácií. Dokumentácia API obsahuje informácie o dostupných koncových bodoch a parametroch.

Autentifikácia/ Test

Tento koncový bod REST umožňuje autentifikáciu s integráciou poskytnutím kľúča API v hlavičke požiadavky X-KEY.

Žiadosť:

• Metóda: ZÍSKAŤ
• Cesta: /externá/v0/zapier/webhooks/
• hlavička:

• KĽÚČ X: Kľúč API pre autentifikáciu.

Odpoveď:

Po úspešnej autentifikácii bude odpoveď vo formáte JSON:

{

„connectionName“: „Testovanie názvu nájomcu“

}

Popis atribútov:

• Názov pripojenia: Meno nájomcu, s ktorým sme nadviazali spojenie.

‍

‍