Перейти до контенту
Українська — Україна
  • Немає пропозицій, оскільки поле пошуку пусте.

Як працювати з API Poster: відповіді на поширені запитання

У цій статті зібрали відповіді на поширені запитання про API Poster, акаунт розробника, створення та публікацію інтеграцій, авторизацію, вебхуки й роботу платформ POS та Device.


Перейдіть до потрібного розділу, щоб знайти відповідь на своє запитання:


Загальні запитання

Що таке акаунт розробника і для чого він потрібен

Акаунт розробника — це спеціальний акаунт Poster, який містить:

  • Тестове середовище — у ньому доступні всі функції звичайного клієнтського акаунта Poster.
  • Інструменти для розробки застосунків — за їх допомогою ви створюєте інтеграції для подальшої публікації в Каталозі застосунків Poster.

Зареєструйте акаунт розробника одним із двох способів за інстуркцією

☝️ Окремий акаунт розробника потрібен, якщо ви плануєте публікувати інтеграцію в Каталозі застосунків Poster.

💡 Якщо ви розробляєте інтеграцію для власних потреб або одного конкретного клієнта, наприклад для підключення Poster до особистого сайту, достатньо токена особистої інтеграції з клієнтського акаунта.


Чи потрібно платити за акаунт розробника

Ні, акаунт розробника безкоштовний.

Одразу після реєстрації акаунт автоматично продовжується на 15 днів. Після завершення цього терміну напишіть у чат підтримки та попросіть продовжити акаунт розробника.


Як зв'язати акаунт розробника з акаунтом клієнта Poster

Пов'язувати акаунти не потрібно. Акаунт розробника — окремий акаунт, у якому ви створюєте та налаштовуєте інтеграцію.

Коли інтеграція готова, клієнт підключає її до свого акаунта за прямим посиланням або через Каталог застосунків Poster, якщо інтеграцію опубліковано.

💡 Взаємодія відбувається не між акаунтами, а між застосунком розробника й акаунтом клієнта через API-запити. Щоб визначити, до якого акаунта належить запит, використовується токен доступу.

Чи можна за допомогою API додати власний функціонал у Poster QR?

Ні. Poster QR не має власного API, тому безпосередньо взаємодіяти з ним через інтеграцію не вийде.

Водночас більшість налаштувань, пов'язаних із меню, доступні через Web API Poster.


Маркетплейс і публікація інтеграцій

Де знайти потрібну інтеграцію

Усі доступні інтеграції зібрані в Каталозі застосунків Poster.

Якщо ви не знайшли потрібного застосунку, зверніться до стороннього розробника. Він допоможе створити інтеграцію з необхідним функціоналом на основі відкритого API Poster.


Чи обов'язково публікувати застосунок у Каталозі застосунків Poster

Ні, ви можете не публікувати застосунок у каталозі та надавати доступ до нього лише своїм клієнтам.

Для підключення інтеграції надішліть клієнтам пряме посилання такого формату:

https://joinposter.com/applications/Your-Integration-Name


Чи можу я продавати свою інтеграцію через Poster

Так. Ви можете розмістити свою інтеграцію в Каталозі застосунків Poster, щоб її могли знайти та підключити інші користувачі Poster.

Для цього підготуйте назву й маркетинговий опис застосунку, додайте зображення та надішліть його на рев'ю. Також потрібно буде презентувати інтеграцію нашому менеджеру.

Після публікації інтеграція стане доступною користувачам Poster у 23 тисячах локацій у 122 країнах світу. Ви зможете залучати нових клієнтів і продавати свій продукт через Poster, а вбудований білінг спростить приймання оплат за інтеграцію.


Скільки триває рев'ю інтеграції в Каталозі застосунків Poster

Перевірка інтеграції триває до 14 днів.
💡Повторне рев'ю після внесення змін також займає до 14 днів.

Щоб спростити перевірку та уникнути зайвих затримок:

  • Протестуйте застосунок перед поданням на рев'ю. Переконайтеся, що він коректно працює в усіх передбачених користувацьких сценаріях.
  • Надайте тестовий доступ до вашого сервісу або повідомте, якщо такої можливості немає.
  • Запишіть відеоінструкцію з підключення та використання інтеграції. Вона також допоможе майбутнім користувачам швидше розібратися з роботою застосунку.
  • Вкажіть клієнтів Poster, які вже тестують ваш застосунок.
  • Заповніть маркетинговий опис, додайте інструкцію для користувачів і вкажіть ціни для кожного регіону.


Чи потрібно повторно надсилати інтеграцію на рев'ю після змін у POS-платформі або коді застосунку

Ні. Якщо ви змінили код застосунку або його POS-платформу, повторне рев'ю не потрібне.

Щоб застосувати зміни в POS-платформі, виконайте команду: npm run deploy


Коли зміни з'являться в клієнта після деплою

Після деплою клієнту потрібно двічі перезавантажити застосунок Poster. Після цього зміни стануть доступними.


Чи потрібно повторно надсилати інтеграцію на рев'ю після зміни її налаштувань

Так, повторне рев'ю потрібне, якщо ви змінили будь-які з таких параметрів:

  • маркетинговий опис;
  • URL для вебхуків;
  • URL для OAuth;
  • URL для Manage;
  • доступи до API.

Надішліть інтеграцію на повторне рев'ю, щоб ми перевірили оновлені дані та опублікували зміни.


Авторизація та доступ


Де отримати токен, якщо мені не потрібен окремий застосунок

Зареєструйте акаунт Poster та відкрийте адмін-панель. Перейдіть у Доступ → Інтеграції → Особиста інтеграція та скопіюйте ключ.

Токен особистої інтеграції підходить, якщо ви створюєте інтеграцію для одного клієнта, наприклад для підключення власного сайту до Poster.

☝️Якщо інтеграцією користуватимуться різні клієнти, налаштуйте OAuth-авторизацію. Вона дає змогу отримувати окремі токени доступу для кожного клієнтського акаунта.


Як налаштувати OAuth-авторизацію

Перегляньте наш вебінар про OAuth-авторизацію або скористайтеся текстовою інструкцією з налаштування OAuth.


Скільки часу діє токен доступу

Токен доступу дійсний протягом 2 років із моменту випуску.


Що робити, якщо термін дії токена закінчився

Якщо термін дії токена закінчився, перепідключіть інтеграцію та пройдіть OAuth-авторизацію повторно. Після цього ви отримаєте новий токен, дійсний ще 2 роки.

Токен особистої інтеграції можуть перевипустити працівники підтримки. Для цього напишіть нам у чат.


Web API


Чому Web API повертає помилку на мій запит

Перевірте параметри code та message у відповіді з помилкою.

Параметр message містить короткий опис причини помилки, а перелік кодів помилок наведено на сторінці документації Web API.


Як інтегрувати сайт на Tilda, OpenCart, Wix, WordPress, uKit або самописний сайт із Poster, щоб отримувати онлайн-замовлення

Для інтеграції сайту з Poster зверніться до стороннього розробника. Він допоможе налаштувати передавання онлайн-замовлень за допомогою API Poster.

Ми також підготували документацію з інтеграції інтернет-магазинів із Poster.

Для сайтів на WordPress + WooCommerce у нашому каталозі застосунків є готова інтеграція.


Чи можна через API передавати зображення товарів, тех. карток або категорій

Ні, API Poster не підтримує передавання зображень для товарів, тех. карток і категорій.

Завантажуйте фотографії безпосередньо в адмін-панелі Poster у розділі Меню.


Як перевірити номер телефону перед створенням онлайн-замовлення або картки клієнта

Щоб перевірити формат номера телефону до надсилання API-запиту та уникнути помилок через некоректні дані, використовуйте бібліотеку libphonenumber.


Вебхуки

Чи можна використовувати вебхуки без створення застосунку

Ні. Щоб отримувати вебхуки від Poster, створіть застосунок в акаунті розробника та налаштуйте для нього URL вебхуків.


Чому мені не надходять вебхуки

Якщо ви не отримуєте вебхуки, перевірте такі налаштування:

  1. URL для вебхуків. Переконайтеся, що сервер приймає POST-запити та повертає відповідь зі статусом 200.
  2. Налаштування застосунку. Перевірте, чи правильно вказано URL для вебхуків. Після натискання Перевірити має відображатися зелена галочка.
  3. Підписки на вебхуки. Переконайтеся, що в налаштуваннях застосунку ви підписалися на отримання вебхуків для потрібних сутностей.
  4. Надсилання вебхука. Спробуйте зімітувати надсилання вебхука: змініть в адмін-панелі Poster сутність, для якої очікуєте сповіщення.
  5. Підключення інтеграції. Перевірте, чи підключено застосунок до акаунта, від якого ви очікуєте вебхуки.
  6. Публікація застосунку. Якщо застосунок уже опублікований у Каталозі застосунків, дочекайтеся завершення повторного рев'ю.
    💡 Зміни в налаштуваннях набудуть чинності після їхнього погодження з нашого боку.

POS-платформа

Чому на касі немає перемикача Dev/Prod

Щоб перемикач Dev/Prod з'явився на касі:

  1. Увімкніть перемикач POS-платформа в налаштуваннях свого застосунку.
  2. В акаунті розробника додайте до списку розробників акаунт Poster, на касі якого потрібно перевірити інтеграцію.
  3. Підключіть інтеграцію до цього акаунта Poster через Каталог застосунків Poster.


Чи можна надсилати CORS-запити JavaScript через браузер

Ні, такі запити блокуються. Для надсилання запитів використовуйте сторонні інструменти, наприклад Postman.


Чи можна додати дві або більше кнопок застосунку в POS-платформі

Ні. Для одного застосунку дозволена лише одна кнопка в POS-платформі.


Чи можна додати додаткову інформацію до чека

Так. Щоб додати текст до друку, використовуйте метод orders.setPrintText.

Метод orders.printReceipt дає змогу надрукувати пречек із QR-кодом і додатковим текстом.


Device-платформа

Чи є емулятор термопринтера та фіскального реєстратора

Повноцінного емулятора термопринтера та фіскального реєстратора немає.

Якщо вам потрібно отримувати лише байти, локально запустіть сервер принтера на порту 9100.


Якщо не знайшли відповідь на своє запитання або потрібна додаткова допомога, напишіть нам у чат.