> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Short URL API 接続説明

> Short link generation 集成指南 - Ace Data Cloud

本文では、長いURLを短いURLに変換するShort URL APIの接続説明を紹介します。

## 申請プロセス

APIを使用するには、まず[Short URL API](https://platform.acedata.cloud/documents/shorturl)の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：

![](https://cdn.acedata.cloud/q6ytrc.png)

まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

初回申請時には無料のクレジットが付与され、このAPIを無料で使用できます。

## 基本使用

まず、基本的な使用方法を理解します。変換したい長いURLを入力することで、処理された結果を得ることができます。まず、シンプルに`content`フィールドを渡す必要があります。次に、インターフェース上で対応する内容を記入します。以下の図のように：

<p>
  <img src="https://cdn.acedata.cloud/4ascb2.png" width="500" className="m-auto" />
</p>

ここでは、Request Headersを設定しました。内容は以下の通りです：

* `accept`：受け取りたいレスポンス結果の形式。ここでは`application/json`、つまりJSON形式を記入します。
* `authorization`：APIを呼び出すためのキー。申請後、直接ドロップダウンから選択できます。

また、Request Bodyを設定しました。内容は以下の通りです：

* `content`：短縮するURLの内容。

選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：

<p>
  <img src="https://cdn.acedata.cloud/r3uakb.png" width="500" className="m-auto" />
</p>

「Try」ボタンをクリックするとテストが行えます。上の図のように、以下の結果が得られました：

```json theme={null}
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
```

返された結果には複数のフィールドがあり、以下のように説明されます：

* `success`：ここでのタスクが成功したかどうかの状態。
* `data`：ここで変換されたURLを含みます。

元の長いURL `https://platform.acedata.cloud/documents/shorturl` が、短いURL `https://surl.id/1uHCs01xa5` に成功裏に変換されたことがわかります。

また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURLのコードは以下の通りです：

```shell theme={null}
curl -X POST 'https://api.acedata.cloud/shorturl' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "content": "https://platform.acedata.cloud/documents/shorturl"
}'
```

Pythonの接続コードは以下の通りです：

```python theme={null}
import requests

url = "https://api.acedata.cloud/shorturl"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "content": "https://platform.acedata.cloud/documents/shorturl"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## エラーハンドリング

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：

* `400 token_mismatched`：不正なリクエスト、パラメータが不足または無効である可能性があります。
* `400 api_not_implemented`：不正なリクエスト、パラメータが不足または無効である可能性があります。
* `401 invalid_token`：認証されていない、無効または不足している認証トークン。
* `429 too_many_requests`：リクエストが多すぎます、レート制限を超えました。
* `500 api_error`：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

### エラー応答の例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

この文書を通じて、Short URL APIを使用して長いURLを短いURLに変換する方法を理解しました。この文書が、APIの接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。