Overleaf Import API

​

“Overleaf Import API” -ominaisuus

Ayakaleaf Pro v6.3:sta alkaen voit luoda linkkejä, jotka tuovat LaTeX-tiedoston tai zip-pakatun projektin URL-osoitteesta ja avaavat sen omassa Ayakaleaf-instanssissasi, samaan tapaan kuin Overleafin “Open in Overleaf” -API.

Tämä ominaisuus on oletuksena käytössä; sinun tarvitsee vain avata your.overleaf.com/devs nähdäksesi yksityiskohtaisen sivun ja ohjeet.

/devs-sivu edellyttää kirjautumista, ellei OVERLEAF_ALLOW_PUBLIC_ACCESS=true; katso Kirjautumattomat vierailijat.

Jos esimerkiksi isännöit LaTeX-tiedostoa osoitteessa https://example.com/main.tex tai kokonaista projektia osoitteessa https://example.com/project.zip, voit luoda linkin, joka tuo sen omaan Ayakaleaf Pro -instanssiisi ja avaa uuden projektin:

LaTeX-tiedosto

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

ZIP-projekti

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

Korvaa ayakaleaf.example.com instanssisi verkkotunnuksella.

​

LaTeX-projektin avaaminen Ayakaleaf Prossa

Ayakaleaf Pro v6.3:sta alkaen voit luoda linkin, joka tuo LaTeX-tiedoston tai zip-pakatun projektin omaan Ayakaleaf Pro -instanssiisi. Kun joku avaa linkin, Ayakaleaf Pro luo annetusta tiedostosta uuden projektin ja avaa sen editorissa.

Osoita linkki instanssisi /docs-päätepisteeseen:

Parametri	Kuvaus	Esimerkki
snip_uri	Tuotavan LaTeX-tiedoston URL. Myös yksittäinen ZIP-tiedosto hyväksytään, mutta käytä projekteille parametria zip_uri.	https://example.com/main.tex
zip_uri	Tuotavan zip-pakatun LaTeX-projektin URL.	https://example.com/project.zip
snip_uri[]	Tuo useita tiedostoja toistamalla tätä parametria.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Aseta tiedostonimi kullekin snip_uri[]-parametrille samassa järjestyksessä.	snip_name[]=main.tex
engine	Aseta kääntäjä: latex_dvipdf, pdflatex, xelatex tai lualatex.	engine=xelatex
main_document	Aseta tuodun projektin pää-.tex-tiedosto.	main_document=main.tex
name	Aseta uuden projektin nimi. Myös project_name hyväksytään.	name=My%20Project

Jos tiedostosi esimerkiksi isännöidään osoitteessa example.com, nämä linkit tuovat ne Ayakaleaf Pro -instanssiin, jota isännöidään osoitteessa ayakaleaf.example.com .

​

Projektin tuominen Base64-koodauksella

Voit upottaa LaTeX-tiedoston tai zip-pakatun projektin suoraan “Open in Ayakaleaf” -linkkiin Base64-data-URL-osoitteena. Näin voit luoda tuontilinkin ilman, että tiedostoa tarvitsee isännöidä erillisessä URL-osoitteessa.

Sisältö	Parametri	Data-URL-muoto
LaTeX-tiedosto	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Zip-pakattu projekti	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Jos haluat tuoda ZIP-projektin, koodaa ZIP-tiedosto Base64-muotoon ja välitä se sen sijaan parametrilla zip_uri. Käytä encodeURIComponent-funktiota koko data-URL-osoitteeseen kumpaakin linkkiä muodostaessasi. Käytä suurille projekteille isännöityä ZIP-URL-osoitetta, koska selainten ja palvelinten URL-pituusrajoitukset voivat tehdä Base64-linkeistä epäkäytännöllisiä.

​

”Open in Ayakaleaf” -painikkeen lisääminen

Voit käyttää HTML-lomaketta tiedoston tuomiseen, kun vierailija napsauttaa painiketta. Lähetä lomake instanssisi /docs-päätepisteeseen määritteellä method="post".

Isännöidylle LaTeX-tiedostolle:

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

Jos haluat tuoda zip-pakatun projektin, korvaa snip_uri parametrilla zip_uri ja osoita se ZIP-tiedostoon. Voit myös lähettää LaTeX-lähdekoodin suoraan käyttämällä parametria snip raakatekstille tai encoded_snip URL-koodatulle tekstille.

Korvaa ayakaleaf.example.com instanssisi verkkotunnuksella. Jos instanssissasi on käytössä eri alkuperää olevien pyyntöjen esto, lisää lomaketta isännöivä sivusto muuttujaan ALLOWED_ORIGINS.

​

Kirjautumattomat vierailijat

Uusi projekti luodaan vierailijan tilille, joten hänen on kirjauduttava sisään. Se, miten kirjautumaton vierailija pääsee perille, riippuu siitä, miten tuonti lähetetään:

• Linkit (GET /docs?...) toimivat jokaisessa instanssissa: vierailija ohjataan kirjautumissivulle, ja tuonti jatkuu kirjautumisen jälkeen.
• Lomakkeet (POST /docs) edellyttävät kirjautumattomille vierailijoille asetusta OVERLEAF_ALLOW_PUBLIC_ACCESS=true. Lähetys säilytetään tällöin 10 minuuttia, kunnes vierailija on kirjautunut sisään, ja sitä käytetään kerran.

Oletuksena (kun OVERLEAF_ALLOW_PUBLIC_ACCESS ei ole asetettu) kirjautumattoman vierailijan lähettämä lomake ohjataan kirjautumissivulle ennen kuin Ayakaleaf Pro lukee sen, ja lähetys menetetään: kirjautumisen jälkeen vierailija näkee ilmoituksen no snippet, snip_uri or zip_uri provided. Käytä linkkejä, pyydä vierailijoita kirjautumaan ensin tai ota julkinen pääsy käyttöön; katso Sivujen käyttöoikeudet.

Millaisia ZIP- tai TeX-resursseja voin tuoda?

Ayakaleaf Pro käyttää ulkoisten resurssien hakemiseen linked-url-proxy-mikropalvelua (jota käytetään pääasiassa ominaisuudessa external-url.md). Yleisesti ottaen mitä tahansa Internetissä julkisesti saatavilla olevaa ZIP- tai TeX-resurssia voidaan tuoda. Yksityisissä tai sisäisissä verkoissa isännöidyt resurssit estetään tietoturvasyistä.

Uudelleenjulkaistusta Ayakaleaf Pro 6.3.0 -versiosta (3. lokakuuta 2026) alkaen voit määrittää HTTP(S)-välityspalvelimen ulkoisten ZIP- ja TeX-resurssien hakemiseen muuttujalla OVERLEAF_LINKED_URL_OUTBOUND_PROXY. Katso määritys ja verkkoyhteyksien rajoitukset kohdasta Lähtevä välityspalvelin.