API de importación de Overleaf

​

Funcionalidad “API de importación de Overleaf”

A partir de Ayakaleaf Pro v6.3, puedes crear enlaces que importen un archivo LaTeX o un proyecto comprimido desde una URL y lo abran en tu propia instancia de Ayakaleaf, de forma similar a la API “Open in Overleaf” de Overleaf.

Esta funcionalidad está habilitada por defecto; solo tienes que visitar your.overleaf.com/devs para ver la página detallada y las instrucciones.

La página /devs requiere iniciar sesión, a menos que OVERLEAF_ALLOW_PUBLIC_ACCESS=true; consulta Visitantes sin sesión iniciada.

Por ejemplo, si alojas un archivo LaTeX en https://example.com/main.tex o un proyecto completo en https://example.com/project.zip, puedes crear un enlace que lo importe en tu propia instancia de Ayakaleaf Pro y abra el nuevo proyecto:

Archivo LaTeX

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

Proyecto ZIP

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

Sustituye ayakaleaf.example.com por el dominio de tu instancia.

​

Abrir un proyecto LaTeX en Ayakaleaf Pro

A partir de Ayakaleaf Pro v6.3, puedes crear un enlace que importe un archivo LaTeX o un proyecto comprimido en tu propia instancia de Ayakaleaf Pro. Cuando alguien abre el enlace, Ayakaleaf Pro crea un nuevo proyecto a partir del archivo proporcionado y lo abre en el editor.

Envía el enlace al endpoint /docs de tu instancia:

Parámetro	Descripción	Ejemplo
snip_uri	URL de un archivo LaTeX que se va a importar. También se acepta un único archivo ZIP, pero usa zip_uri para proyectos.	https://example.com/main.tex
zip_uri	URL de un proyecto LaTeX comprimido que se va a importar.	https://example.com/project.zip
snip_uri[]	Importa varios archivos repitiendo este parámetro.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Establece el nombre de archivo de cada snip_uri[], en el mismo orden.	snip_name[]=main.tex
engine	Establece el compilador: latex_dvipdf, pdflatex, xelatex o lualatex.	engine=xelatex
main_document	Establece el archivo .tex principal del proyecto importado.	main_document=main.tex
name	Establece el nombre del nuevo proyecto. También se acepta project_name.	name=My%20Project

Por ejemplo, si tus archivos están alojados en example.com, estos enlaces los importan en una instancia de Ayakaleaf Pro alojada en ayakaleaf.example.com.

​

Importar un proyecto mediante Base64

Puedes incrustar un archivo LaTeX o un proyecto comprimido directamente en un enlace “Open in Ayakaleaf” como una URL de datos en Base64. Esto te permite crear un enlace de importación sin alojar el archivo en una URL independiente.

Contenido	Parámetro	Formato de la URL de datos
Archivo LaTeX	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Proyecto comprimido	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Para importar un proyecto ZIP, codifica el archivo ZIP en Base64 y pásalo mediante zip_uri. Usa encodeURIComponent sobre la URL de datos completa al construir cualquiera de los dos enlaces. Para proyectos grandes, usa una URL de ZIP alojado, ya que los límites de longitud de URL del navegador y del servidor pueden hacer que los enlaces Base64 resulten poco prácticos.

​

Añadir un botón “Open in Ayakaleaf”

Puedes usar un formulario HTML para importar un archivo cuando un visitante haga clic en un botón. Envía el formulario al endpoint /docs de tu instancia con method="post".

Para un archivo LaTeX alojado:

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

Para importar un proyecto comprimido, sustituye snip_uri por zip_uri y haz que apunte al archivo ZIP. También puedes enviar código fuente LaTeX directamente usando snip para texto sin formato o encoded_snip para texto codificado como URL.

Sustituye ayakaleaf.example.com por el dominio de tu instancia. Si tu instancia tiene habilitado el bloqueo de solicitudes entre orígenes, añade el sitio web que aloja el formulario a ALLOWED_ORIGINS.

​

Visitantes sin sesión iniciada

El nuevo proyecto se crea en la cuenta del visitante, por lo que este debe iniciar sesión. La forma en que un visitante sin sesión iniciada llega hasta allí depende de cómo se envíe la importación:

• Los enlaces (GET /docs?...) funcionan en todas las instancias: el visitante es enviado a la página de inicio de sesión y la importación continúa tras iniciar sesión.
• Los formularios (POST /docs) requieren OVERLEAF_ALLOW_PUBLIC_ACCESS=true para los visitantes sin sesión iniciada. En ese caso, el envío se conserva durante 10 minutos hasta que el visitante inicia sesión, y se usa una sola vez.

Por defecto (sin OVERLEAF_ALLOW_PUBLIC_ACCESS definido), un formulario enviado por un visitante sin sesión iniciada se redirige a la página de inicio de sesión antes de que Ayakaleaf Pro lo lea, y el envío se pierde: tras iniciar sesión, el visitante ve no snippet, snip_uri or zip_uri provided. Usa enlaces, pide a los visitantes que inicien sesión primero o habilita el acceso público; consulta Acceso a páginas.

¿Qué recursos ZIP o TeX puedo importar?

Ayakaleaf Pro utiliza el microservicio linked-url-proxy (usado principalmente para external-url.md) para obtener recursos externos. En general, se puede importar cualquier recurso ZIP o TeX accesible públicamente a través de Internet. Los recursos alojados en redes privadas o internas se bloquean por motivos de seguridad.

A partir de la nueva publicación de Ayakaleaf Pro 6.3.0 (3 de octubre de 2026), puedes configurar un proxy HTTP(S) para obtener recursos ZIP y TeX externos con OVERLEAF_LINKED_URL_OUTBOUND_PROXY. Consulta Proxy de salida para conocer la configuración y las restricciones de acceso a la red.