API d'import Overleaf

​

Fonctionnalité « Overleaf Import API »

À partir d’Ayakaleaf Pro v6.3, vous pouvez créer des liens qui importent un fichier LaTeX ou un projet compressé depuis une URL et l’ouvrent dans votre propre instance Ayakaleaf, à la manière de l’API « Open in Overleaf » d’Overleaf.

Cette fonctionnalité est activée par défaut : il vous suffit de vous rendre sur your.overleaf.com/devs pour consulter la page détaillée et les instructions.

La page /devs nécessite une connexion, sauf si OVERLEAF_ALLOW_PUBLIC_ACCESS=true, voir Visiteurs non connectés.

Par exemple, si vous hébergez un fichier LaTeX à l’adresse https://example.com/main.tex ou un projet complet à l’adresse https://example.com/project.zip, vous pouvez créer un lien qui l’importe dans votre propre instance Ayakaleaf Pro et ouvre le nouveau projet :

Fichier LaTeX

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

Projet ZIP

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

Remplacez ayakaleaf.example.com par le domaine de votre instance.

​

Ouvrir un projet LaTeX dans Ayakaleaf Pro

À partir d’Ayakaleaf Pro v6.3, vous pouvez créer un lien qui importe un fichier LaTeX ou un projet compressé dans votre propre instance Ayakaleaf Pro. Lorsque quelqu’un ouvre le lien, Ayakaleaf Pro crée un nouveau projet à partir du fichier fourni et l’ouvre dans l’éditeur.

Envoyez le lien vers le point de terminaison /docs de votre instance :

Paramètre	Description	Exemple
snip_uri	URL d’un fichier LaTeX à importer. Un fichier ZIP unique est également accepté, mais utilisez zip_uri pour les projets.	https://example.com/main.tex
zip_uri	URL d’un projet LaTeX compressé à importer.	https://example.com/project.zip
snip_uri[]	Importez plusieurs fichiers en répétant ce paramètre.	snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib
snip_name[]	Définit le nom de fichier de chaque snip_uri[], dans le même ordre.	snip_name[]=main.tex
engine	Définit le compilateur : latex_dvipdf, pdflatex, xelatex ou lualatex.	engine=xelatex
main_document	Définit le fichier .tex principal du projet importé.	main_document=main.tex
name	Définit le nom du nouveau projet. project_name est également accepté.	name=My%20Project

Par exemple, si vos fichiers sont hébergés sur example.com, ces liens les importent dans une instance Ayakaleaf Pro hébergée sur ayakaleaf.example.com.

​

Importer un projet en Base64

Vous pouvez intégrer un fichier LaTeX ou un projet compressé directement dans un lien « Open in Ayakaleaf » sous forme de data URL Base64. Cela vous permet de créer un lien d’import sans héberger le fichier à une URL distincte.

Contenu	Paramètre	Format de la data URL
Fichier LaTeX	snip_uri	data:application/x-tex;base64,<base64-encoded-tex>
Projet compressé	zip_uri	data:application/zip;base64,<base64-encoded-zip>

Pour importer un projet ZIP, encodez le fichier ZIP en Base64 et transmettez-le plutôt via zip_uri. Utilisez encodeURIComponent sur la data URL complète lors de la construction de l’un ou l’autre lien. Pour les projets volumineux, utilisez une URL de ZIP hébergé, car les limites de longueur d’URL du navigateur et du serveur peuvent rendre les liens Base64 peu pratiques.

​

Ajouter un bouton « Open in Ayakaleaf »

Vous pouvez utiliser un formulaire HTML pour importer un fichier lorsqu’un visiteur clique sur un bouton. Soumettez le formulaire au point de terminaison /docs de votre instance avec method="post".

Pour un fichier LaTeX hébergé :

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

Pour importer un projet compressé, remplacez snip_uri par zip_uri et faites-le pointer vers le fichier ZIP. Vous pouvez également soumettre directement du source LaTeX avec snip pour du texte brut ou encoded_snip pour du texte encodé en URL.

Remplacez ayakaleaf.example.com par le domaine de votre instance. Si votre instance active le blocage des requêtes cross-origin, ajoutez le site web hébergeant le formulaire à ALLOWED_ORIGINS.

​

Visiteurs non connectés

Le nouveau projet est créé dans le compte du visiteur, qui doit donc se connecter. La manière dont un visiteur non connecté y parvient dépend de la façon dont l’import est envoyé :

• Liens (GET /docs?...) : fonctionnent sur toutes les instances ; le visiteur est redirigé vers la page de connexion et l’import se poursuit après la connexion.
• Formulaires (POST /docs) : nécessitent OVERLEAF_ALLOW_PUBLIC_ACCESS=true pour les visiteurs non connectés. La soumission est alors conservée pendant 10 minutes jusqu’à ce que le visiteur se soit connecté, puis utilisée une seule fois.

Par défaut (OVERLEAF_ALLOW_PUBLIC_ACCESS non définie), un formulaire soumis par un visiteur non connecté est redirigé vers la page de connexion avant qu’Ayakaleaf Pro ne le lise, et la soumission est perdue : après connexion, le visiteur voit no snippet, snip_uri or zip_uri provided. Utilisez des liens, demandez aux visiteurs de se connecter d’abord, ou activez l’accès public, voir Accès aux pages.

Quelles ressources ZIP ou TeX puis-je importer ?

Ayakaleaf Pro utilise le microservice linked-url-proxy (principalement utilisé pour external-url.md) pour récupérer les ressources externes. En général, toute ressource ZIP ou TeX accessible publiquement sur Internet peut être importée. Les ressources hébergées sur des réseaux privés ou internes sont bloquées pour des raisons de sécurité.

À partir de la réédition d’Ayakaleaf Pro 6.3.0 (3 octobre 2026), vous pouvez configurer un proxy HTTP(S) pour la récupération des ressources ZIP et TeX externes avec OVERLEAF_LINKED_URL_OUTBOUND_PROXY. Voir Proxy sortant pour la configuration et les restrictions d’accès réseau.