弐次亭が運営するURL短縮サービスです。

URL短縮API使用方法

URL短縮API使用方法

このページではURL短縮APIの使用方法を説明しています。

まだAPIキーを取得されていない方は、https://niji.gq/0/api/manual/をご覧ください。

仕様

API名 URL短縮API
このAPIでできること 任意のURLの短縮
エンドポイント https://niji.gq/0/api/v1/shorten/
リクエストメソッド POST
レスポンス形式 JSON

リクエスト

エンドポイント[https://niji.gq/0/api/v1/shorten/]にPOSTメソッドでリクエストを行ってください。

リクエストパラメータ
パラメータ
api-key 取得したAPIキー
URL 任意のURL
サンプルコード(pythonの場合)


import urllib,urllib2
url = 'https://niji.gq/0/api/v1/shorten/'
params = urllib.urlencode({'api-key':'ここにあなたのAPIキーを入力します。', 'URL':'ここに短縮したいURLを入力します。'})
fp = urllib2.urlopen(url,params)
print fp.read()

このコードを実行すると、レスポンスが表示されます。

レスポンス

JSON形式でレスポンスを返します。

レスポンスデータ
キー
status 返されるHTTPステータスコード
message 様々なメッセージ
result 短縮されたURL
正常レスポンス


{
"status":200,
"message":"success",
"result":"https://niji.gq/??????",
}

エラーの種類
status message 説明
400 API-key is None リクエストパラメータにapi-keyがセットされていないときに送出されます。
400 URL is None リクエストパラメータに短縮対象のURLがセットされていないときに送出されます。
400 invailed URL format リクエストされた短縮対象のURLが不正なURL形式であった時に送出されます。
400 invailed API-key リクエストされたapi-keyが不正であったときに送出されます。
429 request is limited. too many requests. 一定時間内のリクエスト回数が制限を超えたときに送出されます。

エラーが送出された際、resultはnullになります。

 

説明は以上です。

2016/09/02 追記
一部仕様を変更し問題を解決しました。
詳細は以下のURLを御覧ください。
https://www.nijitei.com/info/nijiga-api-fix/

2017/02/12 追記
一部仕様を変更しました。レスポンスコードの変更が行われています。

PAGETOP
Copyright © 2015-2017 弐次亭