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

# API de importação do Overleaf

### Recurso "Overleaf Import API"

A partir do Ayakaleaf Pro v6.3, você pode criar links que importam um arquivo LaTeX ou um projeto compactado a partir de uma URL e o abrem na sua própria instância do Ayakaleaf, de forma semelhante à [API "Open in Overleaf"](https://cn.overleaf.com/devs) do Overleaf.

Este recurso está ativado por padrão; basta visitar `your.overleaf.com/devs` para ver a página detalhada e as instruções.

<Info>
  A página `/devs` exige login, a menos que `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`; consulte [Signed-out visitors](/pt/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>

Por exemplo, se você hospeda um arquivo LaTeX em `https://example.com/main.tex` ou um projeto completo em `https://example.com/project.zip`, pode criar um link que o importa para a sua própria instância do Ayakaleaf Pro e abre o novo projeto:

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

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

Substitua `ayakaleaf.example.com` pelo domínio da sua instância.

#### Abrir um projeto LaTeX no Ayakaleaf Pro

A partir do Ayakaleaf Pro v6.3, você pode criar um link que importa um arquivo LaTeX ou um projeto compactado para a sua própria instância do Ayakaleaf Pro. Quando alguém abre o link, o Ayakaleaf Pro cria um novo projeto a partir do arquivo fornecido e o abre no editor.

Envie o link para o endpoint `/docs` da sua instância:

| Parâmetro | Descrição | Exemplo |
| - | - | - |
| `snip_uri` | URL de um arquivo LaTeX a importar. Um único arquivo ZIP também é aceito, mas use `zip_uri` para projetos. | `https://example.com/main.tex` |
| `zip_uri` | URL de um projeto LaTeX compactado a importar. | `https://example.com/project.zip` |
| `snip_uri[]` | Importa vários arquivos repetindo este parâmetro. | `snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib` |
| `snip_name[]` | Define o nome de arquivo de cada `snip_uri[]`, na mesma ordem. | `snip_name[]=main.tex` |
| `engine` | Define o compilador: `latex_dvipdf`, `pdflatex`, `xelatex` ou `lualatex`. | `engine=xelatex` |
| `main_document` | Define o arquivo `.tex` principal no projeto importado. | `main_document=main.tex` |
| `name` | Define o nome do novo projeto. `project_name` também é aceito. | `name=My%20Project` |

Por exemplo, se os seus arquivos estiverem hospedados em `example.com`, estes links os importam para uma instância do Ayakaleaf Pro hospedada em `ayakaleaf.example.com` .

#### Importar um projeto usando Base64

Você pode incorporar um arquivo LaTeX ou um projeto compactado diretamente num link "Open in Ayakaleaf" como uma data URL em Base64. Isso permite criar um link de importação sem hospedar o arquivo numa URL separada.

| Conteúdo | Parâmetro | Formato da data URL |
| - | - | - |
| Arquivo LaTeX | `snip_uri` | `data:application/x-tex;base64,<base64-encoded-tex>` |
| Projeto compactado | `zip_uri` | `data:application/zip;base64,<base64-encoded-zip>` |

Para importar um projeto ZIP, codifique o arquivo ZIP em Base64 e passe-o através de `zip_uri`. Use `encodeURIComponent` na data URL completa ao construir qualquer um dos links. Para projetos grandes, use uma URL de ZIP hospedado, pois os limites de comprimento de URL do navegador e do servidor podem tornar os links em Base64 impraticáveis.

#### Adicionar um botão "Open in Ayakaleaf"

Você pode usar um formulário HTML para importar um arquivo quando um visitante clica num botão. Envie o formulário para o endpoint `/docs` da sua instância com `method="post"`.

Para um arquivo LaTeX hospedado:

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

Para importar um projeto compactado, substitua `snip_uri` por `zip_uri` e aponte-o para o arquivo ZIP. Você também pode enviar o código-fonte LaTeX diretamente usando `snip` para texto bruto ou `encoded_snip` para texto codificado em URL.

Substitua `ayakaleaf.example.com` pelo domínio da sua instância. Se a sua instância ativar o bloqueio de requisições de origem cruzada, adicione o site que hospeda o formulário a `ALLOWED_ORIGINS`.

#### Visitantes não autenticados

O novo projeto é criado na conta do visitante, por isso ele precisa entrar. A forma como um visitante não autenticado chega lá depende de como a importação é enviada:

* **Links** (`GET /docs?...`) funcionam em todas as instâncias: o visitante é enviado para a página de login e a importação continua depois de entrar.
* **Formulários** (`POST /docs`) exigem `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` para visitantes não autenticados. O envio é então guardado por 10 minutos até que o visitante entre, e usado uma única vez.

<Warning>
  Por padrão (`OVERLEAF_ALLOW_PUBLIC_ACCESS` não definida), um formulário enviado por um visitante não autenticado é encaminhado para a página de login antes de o Ayakaleaf Pro lê-lo, e o envio é perdido: depois de entrar, o visitante vê *no snippet, snip\_uri or zip\_uri provided*. Use links, peça aos visitantes que entrem primeiro ou ative o acesso público; consulte [Page Access](/pt/on-premises/configuration/overleaf-toolkit/public-access#page-access "mention").
</Warning>

<Accordion title="Que recursos ZIP ou TeX posso importar?">
  O Ayakaleaf Pro usa o microsserviço `linked-url-proxy` (usado principalmente para [external-url.md](/pt/on-premises/configuration/overleaf-toolkit/external-url "mention")) para obter recursos externos. Em geral, qualquer recurso ZIP ou TeX publicamente acessível pela Internet pode ser importado. Recursos hospedados em redes privadas ou internas são bloqueados por motivos de segurança.

  A partir do Ayakaleaf Pro 6.3.0 relançado (3 de outubro de 2026), você pode configurar um proxy HTTP(S) para obter recursos ZIP e TeX externos com `OVERLEAF_LINKED_URL_OUTBOUND_PROXY`. Consulte [Outbound Proxy](/pt/on-premises/configuration/overleaf-toolkit/external-url#outbound-proxy "mention") para a configuração e as restrições de acesso à rede.
</Accordion>


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