Свързване на вашите инструменти чрез API
API позволява на външно приложение да достъпва програмно данните на вашата организация: състав на членовете, календари, резервации и фактуриране. Активира се с два клика и се защитава с ключ, списък с разрешени адреси и следене на потреблението.
Как да разберете дали API е за вас
API е предназначен за разработчик, а не за отговорник на организация. Служи, за да свърже вашия акаунт със софтуер, който поръчвате да бъде написан или настроен: сайт по мярка, счетоводен инструмент, собствено информационно табло, връзка към друга система.
За обичайните нужди — извличане на списъка с членовете, масово обновяване на абонаменти, предаване на данни към ръководството — модулите за импорт, експорт и отчети вършат работа, без да пишете и ред код.
API се предлага в бета версия: работата му все още може да се променя.
Активиране на API и получаване на вашия ключ
- Отидете в Администрация›Настройки›API BETA.
- Активирайте Активиране на API модула, след което щракнете върху Запази.
- Вашият API ключ се показва: копирайте го с бутона Копиране и го предайте само на инструмента, който свързвате.
Ключът се предава в HTTP заглавката X-API-Key на всяка заявка. Извикванията се извършват задължително през HTTPS; никаква нешифрована заявка не се приема.
Защита на ключа
Няколко правила си струва да бъдат припомнени на инструмента или на изпълнителя, който го използва:
- никога не поставяйте ключа в хранилище за код; съхранявайте го във конфигурационен файл извън хранилището или в мениджър на тайни;
- ограничете разрешените адреси веднага щом инструментът извиква от постоянен сървър;
- генерирайте нов ключ при най-малкото съмнение — случайно публикуване, изтичане на дневници, край на договор с изпълнител.
Бутонът Регeнериране изисква потвърждение, след което незабавно обезсилва стария ключ. Всички приложения, които са го използвали, спират да работят, докато не получат новия: предупредете ги, преди да щракнете.
Ограничаване на достъпа по IP адрес
Активирайте Ограничение по IP адрес: приемат се само заявките, идващи от адресите, които сте изброили, до 10 IPv4 адреса. Въведете всеки адрес и потвърдете с Добавяне; вашият текущ адрес се показва на екрана, за да ви помогне.
Това е най-ефективната и най-често пренебрегвана защита: дори да бъде разкрит, ключ, ограничен до адреса на вашия изпълнител, остава неизползваем другаде.
Следене на потреблението
Екранът показва непрекъснато какво потребява вашият ключ:
- Използване в тази минута и Използване днес, всяко от които е съотнесено към своята граница, когато е зададена граница;
- Статистика на използване: Тази седмица, Този месец, Общо и Последно запитване.
Над посочените граници допълнителните заявки се отказват временно. Брояч, който постоянно опира до своя таван, обикновено сигнализира зле настроен инструмент, който изисква едни и същи данни в цикъл, вместо да ги кешира.
Датата на последната заявка е полезна в обратна посока: ключ, който е активиран, но не е извикван от месеци, е ключ за деактивиране.
Какво позволява API
Пълната документация с параметрите и примери за извиквания е показана в долната част на екрана на модула. В общи линии:
- Потребители: това е единственият ресурс, който може да се променя. Можете да извеждате списък, да разглеждате, създавате, променяте и изтривате акаунти.
- Конфигурация: абонаменти, профили, групи и възрастови категории могат да се разглеждат, но се конфигурират само от приложението.
- Резервации: календари, свободни часови интервали, резервации и етикети могат да се разглеждат.
- Фактуриране: сметки за фактуриране, поръчки и плащания могат да се разглеждат.
