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

### "Overleaf Import API" 기능

Ayakaleaf Pro v6.3부터 Overleaf의 ["Open in Overleaf" API](https://cn.overleaf.com/devs)와 유사하게, URL에서 LaTeX 파일이나 압축된 프로젝트를 가져와 자신의 Ayakaleaf 인스턴스에서 여는 링크를 만들 수 있습니다.

이 기능은 기본적으로 활성화되어 있으며, `your.overleaf.com/devs`에 방문하기만 하면 자세한 페이지와 안내를 볼 수 있습니다.

<Info>
  `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`가 아니면 `/devs` 페이지에 로그인이 필요합니다. [로그아웃한 방문자](/ko/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>

예를 들어 LaTeX 파일을 `https://example.com/main.tex`에, 또는 전체 프로젝트를 `https://example.com/project.zip`에 호스팅하는 경우, 이를 자신의 Ayakaleaf Pro 인스턴스로 가져와 새 프로젝트를 여는 링크를 만들 수 있습니다:

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

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

`ayakaleaf.example.com`을 자신의 인스턴스 도메인으로 바꾸세요.

#### Ayakaleaf Pro에서 LaTeX 프로젝트 열기

Ayakaleaf Pro v6.3부터 LaTeX 파일이나 압축된 프로젝트를 자신의 Ayakaleaf Pro 인스턴스로 가져오는 링크를 만들 수 있습니다. 누군가 링크를 열면 Ayakaleaf Pro가 제공된 파일로 새 프로젝트를 만들고 에디터에서 엽니다.

링크는 인스턴스의 `/docs` 엔드포인트로 보내세요:

| 매개변수 | 설명 | 예시 |
| - | - | - |
| `snip_uri` | 가져올 LaTeX 파일의 URL입니다. 단일 ZIP 파일도 허용되지만, 프로젝트에는 `zip_uri`를 사용하세요. | `https://example.com/main.tex` |
| `zip_uri` | 가져올 압축된 LaTeX 프로젝트의 URL입니다. | `https://example.com/project.zip` |
| `snip_uri[]` | 이 매개변수를 반복하여 여러 파일을 가져옵니다. | `snip_uri[]=.../main.tex&snip_uri[]=.../refs.bib` |
| `snip_name[]` | 각 `snip_uri[]`의 파일 이름을 같은 순서로 설정합니다. | `snip_name[]=main.tex` |
| `engine` | 컴파일러를 설정합니다: `latex_dvipdf`, `pdflatex`, `xelatex`, `lualatex`. | `engine=xelatex` |
| `main_document` | 가져온 프로젝트의 메인 `.tex` 파일을 설정합니다. | `main_document=main.tex` |
| `name` | 새 프로젝트의 이름을 설정합니다. `project_name`도 허용됩니다. | `name=My%20Project` |

예를 들어 파일이 `example.com`에 호스팅되어 있다면, 이 링크들은 파일을 `ayakaleaf.example.com`에 호스팅된 Ayakaleaf Pro 인스턴스로 가져옵니다.

#### Base64를 사용해 프로젝트 가져오기

LaTeX 파일이나 압축된 프로젝트를 Base64 데이터 URL로 "Open in Ayakaleaf" 링크에 직접 포함할 수 있습니다. 이렇게 하면 파일을 별도의 URL에 호스팅하지 않고도 가져오기 링크를 만들 수 있습니다.

| 콘텐츠 | 매개변수 | 데이터 URL 형식 |
| - | - | - |
| LaTeX 파일 | `snip_uri` | `data:application/x-tex;base64,<base64-encoded-tex>` |
| 압축된 프로젝트 | `zip_uri` | `data:application/zip;base64,<base64-encoded-zip>` |

ZIP 프로젝트를 가져오려면 ZIP 파일을 Base64로 인코딩하여 대신 `zip_uri`로 전달하세요. 어느 링크를 만들든 전체 데이터 URL에 `encodeURIComponent`를 사용하세요. 큰 프로젝트의 경우 브라우저와 서버의 URL 길이 제한 때문에 Base64 링크가 실용적이지 않을 수 있으므로 호스팅된 ZIP URL을 사용하세요.

#### "Open in Ayakaleaf" 버튼 추가

HTML 폼을 사용하면 방문자가 버튼을 클릭할 때 파일을 가져올 수 있습니다. `method="post"`로 인스턴스의 `/docs` 엔드포인트에 폼을 제출하세요.

호스팅된 LaTeX 파일의 경우:

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

압축된 프로젝트를 가져오려면 `snip_uri`를 `zip_uri`로 바꾸고 ZIP 파일을 가리키도록 하세요. 원시 텍스트에는 `snip`을, URL 인코딩된 텍스트에는 `encoded_snip`을 사용하여 LaTeX 소스를 직접 제출할 수도 있습니다.

`ayakaleaf.example.com`을 자신의 인스턴스 도메인으로 바꾸세요. 인스턴스에서 교차 출처 요청 차단을 활성화한 경우, 폼을 호스팅하는 웹사이트를 `ALLOWED_ORIGINS`에 추가하세요.

#### 로그아웃한 방문자

새 프로젝트는 방문자의 계정에 생성되므로 방문자는 로그인해야 합니다. 로그아웃한 방문자가 어떻게 진행하게 되는지는 가져오기를 보내는 방식에 따라 다릅니다:

* **링크**(`GET /docs?...`)는 모든 인스턴스에서 작동합니다: 방문자는 로그인 페이지로 이동하며, 로그인 후 가져오기가 계속됩니다.
* **폼**(`POST /docs`)은 로그아웃한 방문자의 경우 `OVERLEAF_ALLOW_PUBLIC_ACCESS=true`가 필요합니다. 이 경우 제출 내용은 방문자가 로그인할 때까지 10분 동안 보관되며 한 번만 사용됩니다.

<Warning>
  기본적으로(`OVERLEAF_ALLOW_PUBLIC_ACCESS`가 설정되지 않은 경우) 로그아웃한 방문자가 제출한 폼은 Ayakaleaf Pro가 읽기 전에 로그인 페이지로 전송되므로 제출 내용이 사라집니다: 로그인 후 방문자에게 *no snippet, snip\_uri or zip\_uri provided* 메시지가 표시됩니다. 링크를 사용하거나, 방문자에게 먼저 로그인하도록 요청하거나, 공개 접근을 활성화하세요. [페이지 접근](/ko/on-premises/configuration/overleaf-toolkit/public-access#page-access "mention")을 참조하세요.
</Warning>

<Accordion title="어떤 ZIP 또는 TeX 리소스를 가져올 수 있나요?">
  Ayakaleaf Pro는 외부 리소스를 가져오기 위해 `linked-url-proxy` 마이크로서비스(주로 [external-url.md](/ko/on-premises/configuration/overleaf-toolkit/external-url "mention")에 사용됨)를 사용합니다. 일반적으로 인터넷에서 공개적으로 접근할 수 있는 모든 ZIP 또는 TeX 리소스를 가져올 수 있습니다. 사설 또는 내부 네트워크에 호스팅된 리소스는 보안상의 이유로 차단됩니다.

  재출시된 Ayakaleaf Pro 6.3.0(2026년 10월 3일)부터 `OVERLEAF_LINKED_URL_OUTBOUND_PROXY`로 외부 ZIP 및 TeX 리소스를 가져오기 위한 HTTP(S) 프록시를 구성할 수 있습니다. 구성 및 네트워크 접근 제한에 대해서는 [아웃바운드 프록시](/ko/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.