Автоматизуйте Transept за допомогою API
Усе, що робить редактор, може робити й скрипт. API призначений для інтеграції Transept у конвеєр — CMS, завдання локалізації, етап CI — щоб переклад виконувався без відкриття програми.
Як отримати ключ API?
Створіть особистий ключ API в розділі Налаштування → Розробник. Він доступний на всіх планах, включно з Безкоштовним — немає окремого обмеження, використання лімітується вашим балансом слів. Дайте ключу назву, за бажанням встановіть термін дії та скопіюйте секрет, коли він з'явиться: він відображається один раз і не може бути відновлений пізніше. Відкликати ключ можна в будь-який час на цій же сторінці.
Запити автентифікуються за допомогою ключа в заголовку Authorization: Bearer tsk_live_… — лише в заголовку, ніколи в URL-адресі.
Як імпортувати документи через API?
Створюйте документ із простого тексту, HTML чи Markdown або завантажуйте файл — підтримуються ті самі формати, що й у додатку. Ви також можете імпортувати таблицю рядків (.tstrings.json): структурований формат для тексту інтерфейсу або ігрових рядків, де кожен рядок є окремою одиницею зі сталим ключем і власним контекстом — приміткою про те, що це таке, де воно відображається, обмеженням кількості символів та значенням плейсхолдерів. Уся ця інформація передається моделі; плейсхолдери на кшталт {name} захищені від видалення чи перейменування, а форми множини розгортаються відповідно до мови (одна англійська форма перетворюється на дві в німецькій та чотири в українській). Будь-які переклади, що вже містяться у файлі, імпортуються як є, безкоштовно, і відразу поповнюють пам'ять перекладів.
Як запустити обробку для кількох мов одним викликом?
Груповий запуск дозволяє перекладати документ на кілька мов одночасно. Вкажіть назву документа, Workflow або шаблон для запуску та цільові мови; Transept створить відсутні мовні версії та запустить Workflow для кожної з них. Увесь процес відстежується за одним ID — опитуйте його, щоб дізнатися про прогрес кожної мови та чи очікує переклад на перевірку.
Для повторних запусків надішліть поточний файл таблиці рядків ще раз, і Transept визначить, що змінилося: незмінені рядки збережуть свої переклади (і вже виконану перевірку), а запуск опрацює лише нові або дійсно змінені одиниці — це API-версія функції Запускати лише для зміненого. Запит на створення завдання також приймає заголовок Idempotency-Key, тому повторна спроба після мережевого збою поверне початковий результат замість створення другого документа та повторного рахунку.
Як отримувати події через вебхуки?
Замість опитування зареєструйте URL-адресу, і Transept надсилатиме сповіщення про подію, коли запуск завершується або переривається помилкою, коли перевірка готова до перегляду, коли завершується обробка завантаження або коли готовий експорт. Кожна доставка містить заголовок HMAC-SHA256 X-Transept-Signature: t=…,v1=…, щоб ваш сервер міг підтвердити, що запит надійшов саме від нас; якщо кінцева точка не відповідає, система повторюватиме спроби з поступовим збільшенням інтервалу перед її вимкненням.
Тригери Notion: надайте Transept доступ до сторінки
Workflow також може запускатися автоматично за допомогою автоматизації бази даних Notion: спрямуйте вебхук автоматизації на URL-адресу тригера, і Transept виконає Workflow для сторінки, яку було змінено. Нюанс у тому, що вебхук Notion ніколи не передає вміст сторінки — він лише повідомляє, яка саме сторінка спрацювала. Transept зчитує цю сторінку через ваше підключення Notion, тому мають бути виконані дві умови, інакше кожне спрацювання буде відхилено через помилку доступу, а на картці тригера з'явиться примітка «не вдалося прочитати сторінку Notion»:
- Підключіть Notion у Transept — у розділі Налаштування → Інтеграції. Це одноразове OAuth-підключення, яке дозволяє Transept зчитувати дані від вашого імені.
- Надайте інтеграції доступ до вихідної бази даних у Notion — відкрийте базу даних (або сторінку), натисніть на меню •••, виберіть Connections і додайте Transept. Підключення Notion у «Налаштуваннях» саме по собі не надає доступу до конкретної бази даних; без цього кроку з'єднання буде активним, але сторінка залишиться недоступною для читання.
- Запуск за зміною властивості, а не лише вмісту. Автоматизації Notion спрацьовують при зміні властивостей (і додаванні сторінок), тому саме лише редагування тексту сторінки може нічого не запустити. Надійний варіант — властивість Status, за якою стежить автоматизація: змініть її значення (наприклад, на «Ready to translate»), і саме ця зміна активує тригер.
Де знаходиться довідка з API?
Повний список кінцевих точок опубліковано як специфікацію OpenAPI, яку можна імпортувати в n8n, Zapier або генератор коду: перегляньте її за адресою /public/v1/docs у вашому Transept API або завантажте необроблений JSON за адресою /public/v1/openapi.json. Запуски через API тарифікуються за кількістю слів точно так само, як і в редакторі додатка.
Досі потрібна допомога? Запитайте Literess у застосунку або напишіть на [email protected].