Overleaf Import API

​

Функція «Overleaf Import API»

Починаючи з Ayakaleaf Pro v6.3, ви можете створювати посилання, які імпортують файл LaTeX або заархівований проєкт за URL-адресою та відкривають його у вашому власному екземплярі Ayakaleaf, подібно до API «Open in Overleaf» від Overleaf.

Цю функцію ввімкнено за замовчуванням; щоб переглянути детальну сторінку та інструкції, достатньо відкрити your.overleaf.com/devs.

Сторінка /devs вимагає входу в систему, якщо не встановлено OVERLEAF_ALLOW_PUBLIC_ACCESS=true, див. Відвідувачі без входу.

Наприклад, якщо ви розміщуєте файл LaTeX за адресою https://example.com/main.tex або повний проєкт за адресою https://example.com/project.zip, ви можете створити посилання, яке імпортує його до вашого власного екземпляра Ayakaleaf Pro і відкриває новий проєкт:

Файл LaTeX

https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fmain.tex

ZIP-проєкт

https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fproject.zip

Замініть ayakaleaf.example.com на домен вашого екземпляра.

​

Відкриття проєкту LaTeX в Ayakaleaf Pro

Починаючи з Ayakaleaf Pro v6.3, ви можете створити посилання, яке імпортує файл LaTeX або заархівований проєкт до вашого власного екземпляра Ayakaleaf Pro. Коли хтось відкриває посилання, Ayakaleaf Pro створює новий проєкт із наданого файлу та відкриває його в редакторі.

Спрямуйте посилання на ендпоінт /docs вашого екземпляра:

Параметр	Опис	Приклад
snip_uri	URL файлу LaTeX для імпорту. Також приймається окремий ZIP-файл, але для проєктів використовуйте zip_uri.	https://example.com/main.tex
zip_uri	URL заархівованого проєкту LaTeX для імпорту.	https://example.com/project.zip
snip_uri[]	Імпорт кількох файлів шляхом повторення цього параметра.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Задає назву файлу для кожного snip_uri[] у тому самому порядку.	snip_name[]=main.tex
engine	Задає компілятор: latex_dvipdf, pdflatex, xelatex або lualatex.	engine=xelatex
main_document	Задає головний файл .tex в імпортованому проєкті.	main_document=main.tex
name	Задає назву нового проєкту. Також приймається project_name.	name=My%20Project

Наприклад, якщо ваші файли розміщено на example.com, ці посилання імпортують їх до екземпляра Ayakaleaf Pro, розміщеного на ayakaleaf.example.com .

​

Імпорт проєкту за допомогою Base64

Ви можете вбудувати файл LaTeX або заархівований проєкт безпосередньо в посилання «Open in Ayakaleaf» як data URL у форматі Base64. Це дає змогу створити посилання для імпорту без розміщення файлу за окремою URL-адресою.

Вміст	Параметр	Формат data URL
Файл LaTeX	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Заархівований проєкт	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Щоб імпортувати ZIP-проєкт, закодуйте ZIP-файл у Base64 і передайте його натомість через zip_uri. Під час створення будь-якого з цих посилань застосовуйте encodeURIComponent до всього data URL. Для великих проєктів використовуйте розміщений ZIP-файл за URL-адресою, оскільки обмеження довжини URL у браузерах і на серверах можуть зробити посилання Base64 непрактичними.

​

Додавання кнопки «Open in Ayakaleaf»

Ви можете використати HTML-форму, щоб імпортувати файл, коли відвідувач натискає кнопку. Надсилайте форму на ендпоінт /docs вашого екземпляра з method="post".

Для розміщеного файлу LaTeX:

<form action="https://ayakaleaf.example.com/docs" method="post" target="_blank">
  <input type="hidden" name="snip_uri" value="https://example.com/main.tex">
  <input type="hidden" name="engine" value="xelatex">
  <button type="submit">Open in Ayakaleaf</button>
</form>

Щоб імпортувати заархівований проєкт, замініть snip_uri на zip_uri і вкажіть у ньому ZIP-файл. Також можна надіслати вихідний код LaTeX безпосередньо, використовуючи snip для необробленого тексту або encoded_snip для тексту, закодованого для URL.

Замініть ayakaleaf.example.com на домен вашого екземпляра. Якщо у вашому екземплярі ввімкнено блокування міжсайтових (cross-origin) запитів, додайте вебсайт, на якому розміщено форму, до ALLOWED_ORIGINS.

​

Відвідувачі без входу

Новий проєкт створюється в обліковому записі відвідувача, тому йому потрібно увійти в систему. Як відвідувач без входу потрапить туди, залежить від способу надсилання імпорту:

• Посилання (GET /docs?...) працюють на будь-якому екземплярі: відвідувача буде перенаправлено на сторінку входу, а імпорт продовжиться після входу.
• Форми (POST /docs) для відвідувачів без входу потребують OVERLEAF_ALLOW_PUBLIC_ACCESS=true. У такому разі надіслані дані зберігаються протягом 10 хвилин, доки відвідувач не увійде, і використовуються один раз.

За замовчуванням (коли OVERLEAF_ALLOW_PUBLIC_ACCESS не встановлено) форму, надіслану відвідувачем без входу, буде перенаправлено на сторінку входу ще до того, як Ayakaleaf Pro її прочитає, і надіслані дані буде втрачено: після входу відвідувач побачить повідомлення no snippet, snip_uri or zip_uri provided. Використовуйте посилання, попросіть відвідувачів спочатку увійти або ввімкніть публічний доступ, див. Доступ до сторінок.

Які ресурси ZIP або TeX можна імпортувати?

Ayakaleaf Pro використовує мікросервіс linked-url-proxy (переважно використовується для external-url.md) для отримання зовнішніх ресурсів. Загалом можна імпортувати будь-який публічно доступний в Інтернеті ресурс ZIP або TeX. Ресурси, розміщені в приватних або внутрішніх мережах, блокуються з міркувань безпеки.

Починаючи з повторно випущеного Ayakaleaf Pro 6.3.0 (3 жовтня 2026 року), ви можете налаштувати HTTP(S)-проксі для отримання зовнішніх ресурсів ZIP і TeX за допомогою OVERLEAF_LINKED_URL_OUTBOUND_PROXY. Налаштування та обмеження мережевого доступу див. у розділі Вихідний проксі.