p.tl Web API
このドキュメントでは、p.tlの機能を提供するAPIについて解説しています。なお、APIの仕様は予告なく変更される場合があります。
●APIの説明
このAPIでは、下記の手順で短縮したいURLを送信するだけでJSON 形式のURL短縮結果を取得することができます。
- APIキーを取得する。
- APIキーと短縮したいURLを、APIにGETリクエストで送信する。
- URLの短縮結果が返ってくる。
●APIキーについて
APIを利用するためには下記リンクよりAPIキーを取得する必要があります。
●APIの先URL
下記URLにGETリクエストを送信してください。
http://p.tl/api/api_simple.php
●GETパラメータ
下記のGETパラメータを指定してAPIにGETリクエストを送信してください。
| パラメータ | 値 | 説明 |
|---|---|---|
| key | string | APIキーを指定します。APIキーについてはAPIキー発行ページから取得してください。 |
| url | string | (URLエンコードされた)短縮したいURLです。 |
●レスポンスパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| status | string | APIの実行結果が入ります。 |
| long_url | string | 短縮元のURLです。 |
| short_url | string | 短縮されたURLです。 |
| counter | integer | 1日にAPIを利用した回数です。1日に1000回までAPIを利用可能です。 |
●エラー
以下は、レスポンスパラメータの status に入る値です。
| 値 | 説明 |
|---|---|
| ok | URLの短縮が成功しました。 |
| empty long url | 短縮元のURLが入力されていません。 |
| empty API key | APIキーが入力されていません。 |
| API limit | APIの利用回数が上限を越えています。 |
| invalid API key | 不正なAPIキーです。 |
| invalid long url | 短縮できないURLです。 |
●利用制限
このAPIはサーバへの負荷の軽減のため、1つのAPIキーにつき24時間中1000回のリクエストが上限となっています。リクエスト数の上限は予告なく変更される場合があります。