Overleaf Import API

​

Funkcja „Overleaf Import API”

Począwszy od Ayakaleaf Pro v6.3, możesz tworzyć linki, które importują plik LaTeX lub spakowany projekt z adresu URL i otwierają go we własnej instancji Ayakaleaf, podobnie jak API „Open in Overleaf” Overleaf.

Ta funkcja jest domyślnie włączona — wystarczy odwiedzić your.overleaf.com/devs, aby zobaczyć stronę ze szczegółami i instrukcjami.

Strona /devs wymaga zalogowania, chyba że ustawiono OVERLEAF_ALLOW_PUBLIC_ACCESS=true; zobacz Signed-out visitors.

Na przykład, jeśli hostujesz plik LaTeX pod adresem https://example.com/main.tex lub cały projekt pod adresem https://example.com/project.zip, możesz utworzyć link, który zaimportuje go do Twojej instancji Ayakaleaf Pro i otworzy nowy projekt:

Plik LaTeX

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

Projekt ZIP

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

Zastąp ayakaleaf.example.com domeną swojej instancji.

​

Otwieranie projektu LaTeX w Ayakaleaf Pro

Począwszy od Ayakaleaf Pro v6.3, możesz utworzyć link, który importuje plik LaTeX lub spakowany projekt do Twojej własnej instancji Ayakaleaf Pro. Gdy ktoś otworzy link, Ayakaleaf Pro utworzy nowy projekt z dostarczonego pliku i otworzy go w edytorze.

Skieruj link do punktu końcowego /docs swojej instancji:

Parametr	Opis	Przykład
snip_uri	Adres URL pliku LaTeX do zaimportowania. Akceptowany jest również pojedynczy plik ZIP, ale dla projektów używaj zip_uri.	https://example.com/main.tex
zip_uri	Adres URL spakowanego projektu LaTeX do zaimportowania.	https://example.com/project.zip
snip_uri[]	Importuje wiele plików przez powtórzenie tego parametru.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Ustawia nazwę pliku dla każdego snip_uri[], w tej samej kolejności.	snip_name[]=main.tex
engine	Ustawia kompilator: latex_dvipdf, pdflatex, xelatex lub lualatex.	engine=xelatex
main_document	Ustawia główny plik .tex w importowanym projekcie.	main_document=main.tex
name	Ustawia nazwę nowego projektu. Akceptowany jest również project_name.	name=My%20Project

Na przykład, jeśli Twoje pliki są hostowane na example.com, te linki importują je do instancji Ayakaleaf Pro hostowanej pod adresem ayakaleaf.example.com.

​

Importowanie projektu za pomocą Base64

Plik LaTeX lub spakowany projekt możesz osadzić bezpośrednio w linku „Open in Ayakaleaf” jako adres URL danych w formacie Base64. Pozwala to utworzyć link importu bez hostowania pliku pod osobnym adresem URL.

Zawartość	Parametr	Format adresu URL danych
Plik LaTeX	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Spakowany projekt	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Aby zaimportować projekt ZIP, zakoduj plik ZIP w Base64 i przekaż go przez zip_uri. Przy tworzeniu dowolnego z tych linków użyj encodeURIComponent na całym adresie URL danych. W przypadku dużych projektów używaj hostowanego adresu URL pliku ZIP, ponieważ limity długości adresów URL w przeglądarkach i serwerach mogą sprawić, że linki Base64 będą niepraktyczne.

​

Dodawanie przycisku „Open in Ayakaleaf”

Możesz użyć formularza HTML, aby zaimportować plik po kliknięciu przycisku przez odwiedzającego. Wyślij formularz do punktu końcowego /docs swojej instancji z method="post".

Dla hostowanego pliku 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>

Aby zaimportować spakowany projekt, zastąp snip_uri przez zip_uri i wskaż plik ZIP. Możesz także przesłać kod źródłowy LaTeX bezpośrednio, używając snip dla zwykłego tekstu lub encoded_snip dla tekstu zakodowanego w URL.

Zastąp ayakaleaf.example.com domeną swojej instancji. Jeśli Twoja instancja blokuje żądania między domenami (cross-origin), dodaj witrynę hostującą formularz do ALLOWED_ORIGINS.

​

Signed-out visitors

Nowy projekt jest tworzony na koncie odwiedzającego, więc musi on się zalogować. Sposób, w jaki niezalogowany odwiedzający tam trafi, zależy od tego, jak wysyłany jest import:

• Linki (GET /docs?...) działają w każdej instancji: odwiedzający jest kierowany na stronę logowania, a import jest kontynuowany po zalogowaniu.
• Formularze (POST /docs) wymagają OVERLEAF_ALLOW_PUBLIC_ACCESS=true w przypadku niezalogowanych odwiedzających. Przesłane dane są wtedy przechowywane przez 10 minut, do czasu zalogowania się odwiedzającego, i używane jednorazowo.

Domyślnie (gdy OVERLEAF_ALLOW_PUBLIC_ACCESS nie jest ustawione) formularz przesłany przez niezalogowanego odwiedzającego jest przekierowywany na stronę logowania, zanim Ayakaleaf Pro go odczyta, a przesłane dane zostają utracone: po zalogowaniu odwiedzający widzi komunikat no snippet, snip_uri or zip_uri provided. Używaj linków, poproś odwiedzających o wcześniejsze zalogowanie się lub włącz dostęp publiczny; zobacz Page Access.

Jakie zasoby ZIP lub TeX mogę importować?

Ayakaleaf Pro używa mikrousługi linked-url-proxy (wykorzystywanej głównie przez external-url.md) do pobierania zasobów zewnętrznych. Ogólnie można zaimportować dowolny publicznie dostępny zasób ZIP lub TeX dostępny w Internecie. Zasoby hostowane w sieciach prywatnych lub wewnętrznych są blokowane ze względów bezpieczeństwa.

Począwszy od ponownie wydanej wersji Ayakaleaf Pro 6.3.0 (3 października 2026), możesz skonfigurować proxy HTTP(S) do pobierania zewnętrznych zasobów ZIP i TeX za pomocą OVERLEAF_LINKED_URL_OUTBOUND_PROXY. Konfigurację i ograniczenia dostępu do sieci opisano w sekcji Outbound Proxy.