> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overleaf Import API

### Funktion „Overleaf Import API“

Ab Ayakaleaf Pro v6.3 können Sie Links erstellen, die eine LaTeX-Datei oder ein gezipptes Projekt von einer URL importieren und in Ihrer eigenen Ayakaleaf-Instanz öffnen – ähnlich wie Overleafs [„Open in Overleaf“-API](https://cn.overleaf.com/devs).

Diese Funktion ist standardmäßig aktiviert; Sie müssen lediglich `your.overleaf.com/devs` aufrufen, um die ausführliche Seite mit Anleitungen zu sehen.

<Info>
  Die Seite `/devs` erfordert eine Anmeldung, sofern nicht `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` gesetzt ist, siehe [Abgemeldete Besucher](/de/on-premises/configuration/overleaf-toolkit/overleaf-import-api#signed-out-visitors "mention").
</Info>

<Frame>
  <img src="https://mintcdn.com/ayakaleaf-pro/Wx0mJ_Lfqd9J3VFX/images/on-premises/image-51.png?fit=max&auto=format&n=Wx0mJ_Lfqd9J3VFX&q=85&s=5ba20ae774c684ce71df33d454bda528" alt="" width="2102" height="600" data-path="images/on-premises/image-51.png" />
</Frame>

Wenn Sie beispielsweise eine LaTeX-Datei unter `https://example.com/main.tex` oder ein vollständiges Projekt unter `https://example.com/project.zip` hosten, können Sie einen Link erstellen, der es in Ihre eigene Ayakaleaf Pro-Instanz importiert und das neue Projekt öffnet:

<Tabs>
  <Tab title="LaTeX-Datei">
    ```text wrap theme={null}
    https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fmain.tex
    ```
  </Tab>

  <Tab title="ZIP-Projekt">
    ```text wrap theme={null}
    https://ayakaleaf.example.com/docs?snip_uri=https%3A%2F%2Fexample.com%2Fproject.zip
    ```
  </Tab>
</Tabs>

Ersetzen Sie `ayakaleaf.example.com` durch die Domain Ihrer Instanz.

#### Ein LaTeX-Projekt in Ayakaleaf Pro öffnen

Ab Ayakaleaf Pro v6.3 können Sie einen Link erstellen, der eine LaTeX-Datei oder ein gezipptes Projekt in Ihre eigene Ayakaleaf Pro-Instanz importiert. Wenn jemand den Link öffnet, erstellt Ayakaleaf Pro aus der bereitgestellten Datei ein neues Projekt und öffnet es im Editor.

Richten Sie den Link an den Endpunkt `/docs` Ihrer Instanz:

| Parameter | Beschreibung | Beispiel |
| - | - | - |
| `snip_uri` | URL einer zu importierenden LaTeX-Datei. Eine einzelne ZIP-Datei wird ebenfalls akzeptiert, für Projekte sollten Sie jedoch `zip_uri` verwenden. | `https://example.com/main.tex` |
| `zip_uri` | URL eines zu importierenden gezippten LaTeX-Projekts. | `https://example.com/project.zip` |
| `snip_uri[]` | Mehrere Dateien importieren, indem dieser Parameter wiederholt wird. | `snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib` |
| `snip_name[]` | Den Dateinamen für jedes `snip_uri[]` in derselben Reihenfolge festlegen. | `snip_name[]=main.tex` |
| `engine` | Den Compiler festlegen: `latex_dvipdf`, `pdflatex`, `xelatex` oder `lualatex`. | `engine=xelatex` |
| `main_document` | Die Haupt-`.tex`-Datei im importierten Projekt festlegen. | `main_document=main.tex` |
| `name` | Den Namen des neuen Projekts festlegen. `project_name` wird ebenfalls akzeptiert. | `name=My%20Project` |

Wenn Ihre Dateien beispielsweise auf `example.com` gehostet werden, importieren diese Links sie in eine Ayakaleaf Pro-Instanz unter `ayakaleaf.example.com`.

#### Ein Projekt per Base64 importieren

Sie können eine LaTeX-Datei oder ein gezipptes Projekt direkt als Base64-Data-URL in einen „Open in Ayakaleaf“-Link einbetten. So können Sie einen Import-Link erstellen, ohne die Datei unter einer separaten URL hosten zu müssen.

| Inhalt | Parameter | Data-URL-Format |
| - | - | - |
| LaTeX-Datei | `snip_uri` | `data:application/x-tex;base64,<base64-encoded-tex>` |
| Gezipptes Projekt | `zip_uri` | `data:application/zip;base64,<base64-encoded-zip>` |

Um ein ZIP-Projekt zu importieren, kodieren Sie die ZIP-Datei in Base64 und übergeben Sie sie stattdessen über `zip_uri`. Wenden Sie beim Erstellen beider Link-Varianten `encodeURIComponent` auf die vollständige Data-URL an. Verwenden Sie für große Projekte eine gehostete ZIP-URL, da URL-Längenbeschränkungen von Browser und Server Base64-Links unpraktikabel machen können.

#### Eine „Open in Ayakaleaf“-Schaltfläche hinzufügen

Sie können ein HTML-Formular verwenden, um eine Datei zu importieren, wenn ein Besucher auf eine Schaltfläche klickt. Senden Sie das Formular mit `method="post"` an den Endpunkt `/docs` Ihrer Instanz.

Für eine gehostete LaTeX-Datei:

```text theme={null}
<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>
```

Um ein gezipptes Projekt zu importieren, ersetzen Sie `snip_uri` durch `zip_uri` und verweisen Sie auf die ZIP-Datei. Sie können LaTeX-Quelltext auch direkt übermitteln – mit `snip` für Rohtext oder `encoded_snip` für URL-kodierten Text.

Ersetzen Sie `ayakaleaf.example.com` durch die Domain Ihrer Instanz. Wenn Ihre Instanz das Blockieren von Cross-Origin-Anfragen aktiviert hat, fügen Sie die Website, die das Formular hostet, zu `ALLOWED_ORIGINS` hinzu.

#### Abgemeldete Besucher

Das neue Projekt wird im Konto des Besuchers erstellt, daher muss dieser angemeldet sein. Wie ein abgemeldeter Besucher dorthin gelangt, hängt davon ab, wie der Import gesendet wird:

* **Links** (`GET /docs?...`) funktionieren auf jeder Instanz: Der Besucher wird zur Anmeldeseite weitergeleitet, und der Import wird nach der Anmeldung fortgesetzt.
* **Formulare** (`POST /docs`) erfordern für abgemeldete Besucher `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`. Die Übermittlung wird dann bis zu 10 Minuten aufbewahrt, bis sich der Besucher angemeldet hat, und einmalig verwendet.

<Warning>
  Standardmäßig (wenn `OVERLEAF_ALLOW_PUBLIC_ACCESS` nicht gesetzt ist) wird ein von einem abgemeldeten Besucher übermitteltes Formular zur Anmeldeseite umgeleitet, bevor Ayakaleaf Pro es liest, und die Übermittlung geht verloren: Nach der Anmeldung sieht der Besucher *no snippet, snip\_uri or zip\_uri provided*. Verwenden Sie Links, bitten Sie Besucher, sich zuerst anzumelden, oder aktivieren Sie den öffentlichen Zugriff, siehe [Seitenzugriff](/de/on-premises/configuration/overleaf-toolkit/public-access#page-access "mention").
</Warning>

<Accordion title="Welche ZIP- oder TeX-Ressourcen kann ich importieren?">
  Ayakaleaf Pro verwendet den Microservice `linked-url-proxy` (hauptsächlich für [external-url.md](/de/on-premises/configuration/overleaf-toolkit/external-url "mention") genutzt), um externe Ressourcen abzurufen. Grundsätzlich kann jede öffentlich über das Internet zugängliche ZIP- oder TeX-Ressource importiert werden. Ressourcen in privaten oder internen Netzwerken werden aus Sicherheitsgründen blockiert.

  Ab dem neu veröffentlichten Ayakaleaf Pro 6.3.0 (3. Oktober 2026) können Sie mit `OVERLEAF_LINKED_URL_OUTBOUND_PROXY` einen HTTP(S)-Proxy zum Abrufen externer ZIP- und TeX-Ressourcen konfigurieren. Informationen zur Konfiguration und zu Einschränkungen des Netzwerkzugriffs finden Sie unter [Ausgehender Proxy](/de/on-premises/configuration/overleaf-toolkit/external-url#outbound-proxy "mention").
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.