WebServiceについて

WebServiceとは？

短いURLの機能を、他のサービスからご利用できるようにするための仕組み(API)です。
このWebServiceでは、登録可能かの確認、登録、編集、削除などを行うことが可能です。
開発者向けの機能ですが、現在は利用制限は設けておりません。
興味のある方はぜひご利用ください。

WebServiceの仕様

このページではAPIの仕様についてまとめています。
このAPIはREST風の呼び出しで簡単にご利用いただけるようになっています。

呼び出し方法

つぎのアドレスにAPIごとのパラメータを与えてアクセスします。
http://u.ebeta.jp/webservice/**** (※****はAPI名)
(例) 削除: http://u.ebeta.jp/webservice/delete?from=example&key=xxxxxxxxxxxx

HTTPメソッドはGETメソッドを使用します（POSTでも可能です）
APIの一覧は APIについて をご覧ください。

実行結果のデータ形式

APIを実行するとその結果として、XMLデータが返ってきます。
XMLデータは次のようなフォーマットになっています。

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <access-key>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</access_key>
  <errors>
    <error>not found</error>
  </errors>
  <from>abc</from>
  <to>http://ebeta.jp/</to>
  <result>false</result>
</response>

root要素は、response です。 その子要素として、result, from, to, access_key, errors があります。 この中で、result要素は必ず存在し、呼び出しが成功した場合は要素の内容が true, それ以外の場合は false という文字列になります。
現時点では、このデータ形式にDTDはありません。また、ルート要素以下の要素が出現する順番は定まっていません。
すべての要素について次の表にまとめています。

response要素ルート要素
result要素API 呼び出しの成否をあらわします。成功したらtrue、それ以外は false になります。
一部の API では単に真偽を示すためにつかわれます。
from要素短いURLのアドレス部分
to要素転送先のURL
access-key要素短いURLの転送先URLを編集するためのアクセスキー
errors要素呼び出しエラーが１つ以上ある場合、error要素を格納します
error要素errors要素の子要素。エラーを示す文字列

API について
  • check
    説明アドレスが登録可能か問い合わせる
    引数path 問い合わせたい短いURLのアドレス部分の文字列
    戻り値登録済みならresult要素が true になる。　それ以外は false になる。
    実行例 http://u.ebeta.jp/webservice/check?path=example
  • register
    説明アドレスを登録する
    引数from 短いURLのアドレス部分
    to 転送先のURL
    戻り値result要素が true なら登録成功。 access-key要素にアクセスキーが格納される。
    from要素 と to要素はそれぞれ入力値が格納される
    実行例 http://u.ebeta.jp/webservice/register?from=example&to=http://ebeta.jp/
  • get_url
    説明アドレスの転送先URLを問い合わせる
    引数from 短いURLのアドレス部分
    戻り値アドレスが見つかれば result要素が true になり、to要素に転送先のURLが格納される。
    result要素がfalseのときは, errors要素に呼び出しが失敗した理由が格納される
    実行例 http://u.ebeta.jp/webservice/get_url?from=example
  • modify
    説明登録したアドレスの転送先を変更する
    引数from 登録済みの短いURLのアドレス部分
    to 新しい転送先
    key 登録時に発行されたアクセスキー
    戻り値変更に成功すれば result要素が true になり、 to要素に新しい転送先が格納される。
    エラーが発生した場合、 result要素が false となり、errors要素に呼び出しが失敗した理由が格納される。
    実行例 http://u.ebeta.jp/webservice/modify?from=example&to=http://u.ebeta.jp/&key=xxxxxxxxxxxx
  • delete
    説明登録しているアドレスを削除する
    引数from 登録済みの短いURLのアドレス部分
    key 登録時に発行されたアクセスキー
    戻り値result要素 が true であれば、削除に成功。
    result要素が false の時は、削除に失敗したか、アドレスが見つからなかったことを意味する。
    実行例 http://u.ebeta.jp/webservice/delete?from=example&key=xxxxxxxxxxxx