Какво е API и нужно ли ми е?

Срещате тези три букви в офертата на Вашия уеб разработчик или в списъка с функции на счетоводния софтуер: API. Тази статия обяснява какво е това, без да трябва да можете да програмирате.

Краткият отговор

API е врата отзад на Вашия акаунт.

Там, където Вие цъкате в екрана за управление, за да видите колко места са още свободни, друга програма може да попита съвсем същото през тази врата — без някой да седи пред екран. Зад двете врати стоят едни и същи данни: Вашите продукти, цени, свободни места, продажби.

Разликата е в това кой влиза. През предната врата влиза човек с мишка. През задната влиза програма с ключ.

Кога Ви е нужно?

Само когато искате нещо, което екранът за управление не прави. Например:

• да покажете на собствения си сайт кои обиколки още имат места тази седмица, в собствения Ви дизайн, с числа, които са верни в този момент;
• да оставите счетоводителя си да се обслужи сам, за да вземе оборота от миналия месец, вместо всеки месец да получава експорт от Вас;
• екран във фоайето, който показва кой часови интервал започва;
• да продавате от програма, която вече ползвате, без първо да влизате в екрана за управление.

А кога не Ви е нужно? Когато можете да го цъкнете. Изграждането на връзка струва време и поддръжка; да изнесете списък два пъти месечно струва две минути. Изберете първото едва когато второто започне да пречи.

Внимание: не е нужно да го изграждате сами. Този, който го прави — Вашият уеб разработчик, доставчикът на счетоводния софтуер, някой от управата, който може да програмира — има нужда само от две неща: адреса и ключ. И двете са в екрана Ви за управление.

Какво точно предавате

Отворете Настройки → API достъп (този екран е за собственика на организацията). В раздела Ключове има три неща, които можете да предадете:

1. Адресът. Един ред текст. Натам говори другата програма.
2. Техническото описание, връзката, която завършва на openapi.json. С него разработчикът вижда с един поглед всичко възможно: какви данни има, как се искат, какво се връща.
3. Ключ, който създавате сами. Вижте Създаване на API ключ.

Повече не му трябва, а и Вие не бива да давате повече — паролата си със сигурност не.

Какво може и какво не може един ключ

При създаването отмятате какво може ключът. Това не е формалност:

• Четене — да изчита всичко, да не променя нищо. Това е нужно на повечето връзки. Внимание: „всичко“ включва и поръчките Ви и купувачите Ви, с тяхното име и имейл адрес.
• Запис — да създава поръчки, да ги плаща, анулира и възстановява, да заявява фактура, да анулира билети и да ги изпраща повторно по имейл, да регистрира влизания, както и да издава, използва или удължава подаръчни ваучери и годишни карти.
• Уебхукове — да посочва къде могат да отиват съобщенията. Вижте Уебхукове.
• Платено външно — да отбелязва поръчка като платена, без в това да участва доставчик на плащания (банков превод, в брой). Давайте го само на каса или счетоводство, които управлявате сами: който има това право, може да издава билети, без да постъпват пари.

Дайте на всяка връзка собствен ключ само с това, което ѝ трябва. Така можете да отмените един, без да счупите останалите, и виждате в списъка кой още се използва.

Ключът впрочем не е парола, която отваря акаунта Ви: той дава само отметнатото и принадлежи на една организация. Дори да се търкаля някъде, никой не може да вземе с него чужди данни.

Първо безопасен опит

Освен обикновен ключ можете да създадете тестов ключ. Той чете съвсем същите данни. Ако има право и на запис, създава само тестови поръчки: те никога не отиват към доставчика Ви на плащания, не се броят в оборота Ви и се изтриват автоматично след 24 часа. Тестов ключ не може да настройва уебхукове.

Той съществува точно за този момент — някой, който опитва и още не е сигурен какво прави. Оставете уеб разработчика си да започне с тестов ключ и да мине на другия чак накрая.

Едно нещо, което трябва да знаете: и тестовата поръчка заема истинско място (докато не бъде изтрита), а имейлът за потвърждение наистина се изпраща. Затова оставете уеб разработчика си да тества с продукт или часови интервал, който създавате специално за това.

А ако се обърка?

Анулирайте ключа. Натиснете Анулиране в списъка и от този момент той вече не работи. Връзката спира, данните Ви остават. Няма нито една ситуация, в която ключ може да направи нещо, което не можете да спрете с едно натискане.

Какво струва

API-то е част от по-голям план. При по-малък API достъп не се появява в менюто Ви. Ако все пак попаднете на този екран, виждате обяснение, в кой план е API-то и бутон Към абонамента — но не и ключове. Какво влиза в кой план е на страницата с цените на Passavo.

Още за четене

• Създаване на API ключ — самият екран, стъпка по стъпка.
• Уебхукове — да известите сайта си, че нещо е продадено, без той да пита постоянно.
• Настройване на webhooks — самият екран, стъпка по стъпка.
• Порталът за разработчици — за този, който изгражда връзката.