Overleaf Import API

​

De functie “Overleaf Import API”

Vanaf Ayakaleaf Pro v6.3 kun je links maken die een LaTeX-bestand of een gezipt project vanaf een URL importeren en openen in je eigen Ayakaleaf-instantie, vergelijkbaar met de API “Open in Overleaf” van Overleaf.

Deze functie is standaard ingeschakeld; je hoeft alleen your.overleaf.com/devs te bezoeken om de gedetailleerde pagina en instructies te zien.

Voor de pagina /devs moet je ingelogd zijn, tenzij OVERLEAF_ALLOW_PUBLIC_ACCESS=true; zie Signed-out visitors.

Als je bijvoorbeeld een LaTeX-bestand host op https://example.com/main.tex of een volledig project op https://example.com/project.zip, kun je een link maken die het importeert in je eigen Ayakaleaf Pro-instantie en het nieuwe project opent:

LaTeX-bestand

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

ZIP-project

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

Vervang ayakaleaf.example.com door het domein van je instantie.

​

Een LaTeX-project openen in Ayakaleaf Pro

Vanaf Ayakaleaf Pro v6.3 kun je een link maken die een LaTeX-bestand of een gezipt project importeert in je eigen Ayakaleaf Pro-instantie. Wanneer iemand de link opent, maakt Ayakaleaf Pro een nieuw project aan op basis van het opgegeven bestand en opent het in de editor.

Laat de link verwijzen naar het /docs-endpoint van je instantie:

Parameter	Beschrijving	Voorbeeld
snip_uri	URL van een LaTeX-bestand om te importeren. Eén ZIP-bestand wordt ook geaccepteerd, maar gebruik zip_uri voor projecten.	https://example.com/main.tex
zip_uri	URL van een gezipt LaTeX-project om te importeren.	https://example.com/project.zip
snip_uri[]	Importeer meerdere bestanden door deze parameter te herhalen.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Stel de bestandsnaam in voor elke snip_uri[], in dezelfde volgorde.	snip_name[]=main.tex
engine	Stel de compiler in: latex_dvipdf, pdflatex, xelatex of lualatex.	engine=xelatex
main_document	Stel het hoofdbestand .tex in het geïmporteerde project in.	main_document=main.tex
name	Stel de naam van het nieuwe project in. project_name wordt ook geaccepteerd.	name=My%20Project

Als je bestanden bijvoorbeeld op example.com worden gehost, importeren deze links ze in een Ayakaleaf Pro-instantie die op ayakaleaf.example.com wordt gehost.

​

Een project importeren met Base64

Je kunt een LaTeX-bestand of een gezipt project rechtstreeks als Base64-data-URL in een “Open in Ayakaleaf”-link insluiten. Zo kun je een importlink maken zonder het bestand op een afzonderlijke URL te hosten.

Inhoud	Parameter	Indeling van de data-URL
LaTeX-bestand	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Gezipt project	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Om een ZIP-project te importeren, codeer je het ZIP-bestand met Base64 en geef je het in plaats daarvan door via zip_uri. Gebruik encodeURIComponent op de volledige data-URL bij het opbouwen van een van beide links. Gebruik voor grote projecten een gehoste ZIP-URL, omdat limieten voor de URL-lengte in browsers en op servers Base64-links onpraktisch kunnen maken.

​

Een knop “Open in Ayakaleaf” toevoegen

Je kunt een HTML-formulier gebruiken om een bestand te importeren wanneer een bezoeker op een knop klikt. Verstuur het formulier naar het /docs-endpoint van je instantie met method="post".

Voor een gehost LaTeX-bestand:

<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>

Om een gezipt project te importeren, vervang je snip_uri door zip_uri en laat je het naar het ZIP-bestand verwijzen. Je kunt LaTeX-broncode ook rechtstreeks versturen met snip voor platte tekst of encoded_snip voor URL-gecodeerde tekst.

Vervang ayakaleaf.example.com door het domein van je instantie. Als je instantie het blokkeren van cross-origin-verzoeken inschakelt, voeg dan de website die het formulier host toe aan ALLOWED_ORIGINS.

​

Niet-ingelogde bezoekers

Het nieuwe project wordt aangemaakt in het account van de bezoeker, dus die moet inloggen. Hoe een niet-ingelogde bezoeker daar komt, hangt af van hoe de import wordt verzonden:

• Links (GET /docs?...) werken op elke instantie: de bezoeker wordt naar de inlogpagina gestuurd en de import gaat verder na het inloggen.
• Formulieren (POST /docs) vereisen OVERLEAF_ALLOW_PUBLIC_ACCESS=true voor niet-ingelogde bezoekers. De inzending wordt dan 10 minuten bewaard totdat de bezoeker is ingelogd, en eenmalig gebruikt.

Standaard (als OVERLEAF_ALLOW_PUBLIC_ACCESS niet is ingesteld) wordt een formulier dat door een niet-ingelogde bezoeker is verzonden naar de inlogpagina gestuurd voordat Ayakaleaf Pro het leest, en gaat de inzending verloren: na het inloggen ziet de bezoeker no snippet, snip_uri or zip_uri provided. Gebruik links, vraag bezoekers eerst in te loggen of schakel openbare toegang in; zie Page Access.

Welke ZIP- of TeX-bronnen kan ik importeren?

Ayakaleaf Pro gebruikt de microservice linked-url-proxy (voornamelijk gebruikt voor external-url.md) om externe bronnen op te halen. Over het algemeen kan elke openbaar toegankelijke ZIP- of TeX-bron die via internet beschikbaar is, worden geïmporteerd. Bronnen die op privé- of interne netwerken worden gehost, worden om veiligheidsredenen geblokkeerd.

Vanaf de opnieuw uitgebrachte Ayakaleaf Pro 6.3.0 (3 oktober 2026) kun je met OVERLEAF_LINKED_URL_OUTBOUND_PROXY een HTTP(S)-proxy configureren voor het ophalen van externe ZIP- en TeX-bronnen. Zie Outbound Proxy voor de configuratie en beperkingen op netwerktoegang.