> ## 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 インポート API

### 「Overleaf インポート API」機能

Ayakaleaf Pro v6.3 以降では、Overleaf の[「Open in Overleaf」API](https://cn.overleaf.com/devs) と同様に、URL から LaTeX ファイルや zip 圧縮されたプロジェクトをインポートし、自分の Ayakaleaf インスタンスで開くリンクを作成できます。

この機能はデフォルトで有効になっており、`your.overleaf.com/devs` にアクセスするだけで詳細なページと手順を確認できます。

<Info>
  `OVERLEAF_ALLOW_PUBLIC_ACCESS=true` でない限り、`/devs` ページにはログインが必要です。[サインインしていない訪問者](/ja/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>

たとえば、`https://example.com/main.tex` で LaTeX ファイルを、または `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 ファイルや zip 圧縮されたプロジェクトを自分の Ayakaleaf Pro インスタンスにインポートするリンクを作成できます。誰かがそのリンクを開くと、Ayakaleaf Pro は指定されたファイルから新しいプロジェクトを作成し、エディターで開きます。

リンクは、インスタンスの `/docs` エンドポイントに送信します：

| パラメーター | 説明 | 例 |
| - | - | - |
| `snip_uri` | インポートする LaTeX ファイルの URL。単一の ZIP ファイルも受け付けますが、プロジェクトには `zip_uri` を使用してください。 | `https://example.com/main.tex` |
| `zip_uri` | インポートする zip 圧縮された 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 ファイルや zip 圧縮されたプロジェクトを、Base64 のデータ URL として「Open in Ayakaleaf」リンクに直接埋め込むことができます。これにより、ファイルを別の URL でホストすることなくインポートリンクを作成できます。

| コンテンツ | パラメーター | データ URL の形式 |
| - | - | - |
| LaTeX ファイル | `snip_uri` | `data:application/x-tex;base64,<base64-encoded-tex>` |
| zip 圧縮されたプロジェクト | `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>
```

zip 圧縮されたプロジェクトをインポートするには、`snip_uri` を `zip_uri` に置き換え、ZIP ファイルを指定します。また、生のテキストには `snip`、URL エンコードされたテキストには `encoded_snip` を使用して、LaTeX のソースを直接送信することもできます。

`ayakaleaf.example.com` は、お使いのインスタンスのドメインに置き換えてください。インスタンスでクロスオリジンリクエストのブロックが有効になっている場合は、フォームをホストしている Web サイトを `ALLOWED_ORIGINS` に追加してください。

#### サインインしていない訪問者

新しいプロジェクトは訪問者のアカウントに作成されるため、訪問者はログインする必要があります。サインインしていない訪問者がどのようにたどり着くかは、インポートの送信方法によって異なります：

* **リンク**（`GET /docs?...`）はすべてのインスタンスで動作します。訪問者はログインページに送られ、ログイン後にインポートが続行されます。
* **フォーム**（`POST /docs`）をサインインしていない訪問者が使用するには、`OVERLEAF_ALLOW_PUBLIC_ACCESS=true` が必要です。この場合、送信内容は訪問者がログインするまで 10 分間保持され、1 回だけ使用されます。

<Warning>
  デフォルト（`OVERLEAF_ALLOW_PUBLIC_ACCESS` が未設定）では、サインインしていない訪問者が送信したフォームは、Ayakaleaf Pro が読み取る前にログインページに送られ、送信内容は失われます。ログイン後、訪問者には *no snippet, snip\_uri or zip\_uri provided* と表示されます。リンクを使用するか、訪問者に先にログインしてもらうか、パブリックアクセスを有効にしてください。[ページアクセス](/ja/on-premises/configuration/overleaf-toolkit/public-access#page-access "mention")を参照してください。
</Warning>

<Accordion title="どのような ZIP や TeX のリソースをインポートできますか？">
  Ayakaleaf Pro は、外部リソースの取得に `linked-url-proxy` マイクロサービス（主に [external-url.md](/ja/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) プロキシを設定できます。設定とネットワークアクセスの制限については、[アウトバウンドプロキシ](/ja/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.