p.tl Web API

このドキュメントでは、p.tlの機能を提供するAPIについて解説しています。なお、APIの仕様は予告なく変更される場合があります。


●APIの説明

このAPIでは、下記の手順で短縮したいURLを送信するだけでJSON 形式のURL短縮結果を取得することができます。

  1. APIキーを取得する。
  2. APIキーと短縮したいURLを、APIにGETリクエストで送信する。
  3. URLの短縮結果が返ってくる。

●APIキーについて

APIを利用するためには下記リンクよりAPIキーを取得する必要があります。


APIキー発行ページ


●APIの先URL

下記URLにGETリクエストを送信してください。

http://p.tl/api/api_simple.php

●GETパラメータ

下記のGETパラメータを指定してAPIにGETリクエストを送信してください。

パラメータ説明
keystringAPIキーを指定します。APIキーについてはAPIキー発行ページから取得してください。
urlstring(URLエンコードされた)短縮したいURLです。

●レスポンスパラメータ

パラメータ説明
statusstringAPIの実行結果が入ります。
long_urlstring短縮元のURLです。
short_urlstring短縮されたURLです。
counterinteger1日にAPIを利用した回数です。1日に1000回までAPIを利用可能です。

●エラー

以下は、レスポンスパラメータの status に入る値です。

説明
okURLの短縮が成功しました。
empty long url短縮元のURLが入力されていません。
empty API keyAPIキーが入力されていません。
API limitAPIの利用回数が上限を越えています。
invalid API key不正なAPIキーです。
invalid long url短縮できないURLです。

●利用制限

このAPIはサーバへの負荷の軽減のため、1つのAPIキーにつき24時間中1000回のリクエストが上限となっています。リクエスト数の上限は予告なく変更される場合があります。