REST APIリファレンス

Dozens REST APIのリファレンスページは移動しました。

Dozens ヘルプセンター APIリファレンス


下記ドキュメントは今後削除する予定です。上記リファレンスを参照いただくようお願いいたします。

2016年8月23日 





(APIバージョン1.6 2015年6月12日リリース)

(ドキュメントバージョン1.0 2011年2月2日  16:20 更新)
(ドキュメントバージョン1.1 2011年6月23日 23:15 更新):ベータバージョンの記載を削除
(ドキュメントバージョン1.1 2011年6月26日 23:15 更新):TTL記載方法を更新
(ドキュメントバージョン1.2 2011年8月15日 11:25 更新):レコードタイプ記載方法を更新
(ドキュメントバージョン1.3 2011年9月10日 10:45 更新):GoogleAppsドメイン認証レコードタイプ記載方法を更新
(ドキュメントバージョン1.4 2012年3月27日  8:45 更新):TTL変更できるプランについての誤記を訂正(正しくはBasicプランでもTTLは変更可能です)
(ドキュメントバージョン1.5 2014年7月15日  0:00 最終更新) :ドメイン登録時にSOA用メールアドレスを追加、またドメイン更新(SOA用メールアドレス)を追加
(ドキュメントバージョン1.6 2015年6月12日  20:50 最終更新) :ALIASレコード機能追加に伴い文言を追加

DozensのRESTによるAPIのリファレンスです。
本APIの利用は全て自己責任です。Dozensでは利用の結果生じた損害について、一切責任を負いません。
予めご了承の上、お使いください。


概要


URL http://dozens.jp/api

Response/Responseフォーマット
 Format     Accept Header  拡張子  デフォルト
 JSON  application/json  .json  ◯
 XML  application/xml  .xml  
※現在はRequestはjsonフォーマットのみです、近日中にxmlに対応します。
※Responseは拡張子によって判別します。Request=json Response=XMLも可能です。

認証

Request

Dozensにログイン後、プロフィールページのAPI Keyの値をX-Auth-KeyにDozensIDをX-Auth-Userにいれて送信。

GET /api/authorize.json HTTP/1.1
Host: dozens.jp
X-Auth-User: dozens
X-Auth-Key: a8753098B73131kewt987612004957d89

Response
認証に成功した場合、1日間有効なtokenを発行します。
また、全ての操作はauth_tokenをもとに認証されます。
未認証の場合、HTTPコード401を返却します。その場合は再度認証を行って下さい。
Sample
{"auth_token":"6cfb3debbbac7d144e9eb7b701f79c2225bd6646 "}

共通ヘッダー

各種APIの操作に必要な共通ヘッダーです。認証後のauth_tokenを使用して下さい。

GET /api/zone.json HTTP/1.1
Host: dozens.jp
Content-Type: application/json
X-Auth-Token:6cfb3debbbac7d144e9eb7b701f79c2225bd6646
※ゾーンリスト取得の場合

ゾーン(ドメイン)リストの取得


GET http://dozens.jp/api/zone.json
Response
id: 一意なゾーンのID
name: ゾーン名

Sample
{"domain":
    [
        {"id":"2","name":"dnzdns.com"},
        {"id":"1","name":"dozens.jp"}
    ]
}

ゾーンの新規登録


POST http://dozens.jp/api/zone/create.json

Request
name: ゾーン名
add_google_apps: true or false / GoogleAppsのレコードを追加する場合はtrue
google_authorize: TXTによってGoogleAppsの確認をする場合は設定
mailaddress: SOA用のメールアドレス、指定がない場合はユーザー登録のメールアドレスを使用します。

Sample
{
     "name": "dozens.jp",
     "add_google_apps": true,
     "google_authorize": "google_comfirm_txt_record"
     "mailaddress": "domain@dozens.jp"
}

Response
ゾーンリストを返却します。「ゾーン(ドメイン)リストの取得」と同内容

ゾーンの編集


POST http://dozens.jp/api/zone/update/{zone_id}.json

Request
mailaddress: SOA用のメールアドレス

Sample
{
     "mailaddress": "domain@dozens.jp"
}

Response
ゾーンリストを返却します。「ゾーン(ドメイン)リストの取得」と同内容

ゾーンの削除


DELETE http://dozens.jp/api/zone/delete/{zone_id}.json

zone_id: ゾーンID

Response

ゾーンリストを返却します。「ゾーン(ドメイン)リストの取得」と同内容

レコードリストの取得


GET http://dozens.jp/api/record/{zone_name}.json
zone_name: ゾーン名 ex) dozens.jp

Response
id: 一意なレコードのID
name: レコード名
type: A / AAAA / CNAME / MX / TXT / SRV / ALIAS
prio: プライオリティー
ttl: 60 or 3600 or 7200 or 86400 (無料アカウント、miniプランの場合: 7200固定)

Sample
{
    "record":
    [
        {"id":"1","name":"www.dozens.jp","type":"A","prio":null,"content":"192.168.1.80","ttl":"7200"},
        {"id":"2","name":"ghost_cname_auth.dozens.jp","type":"CNAME","prio":null,"content":"ghs.google.com","ttl":"7200"},
        {"id":"4","name":"dozens.jp","type":"MX","prio":"10","content":"ASPMX.L.GOOGLE.COM","ttl":"7200"},
        {"id":"11","name":"dozens.jp","type":"TXT","prio":null,"content":"v=spf1 include:_spf.google.com ~all","ttl":"7200"}
    ]
}

レコードの登録


POST http://dozens.jp/api/record/create.json

Request
domain: ゾーン(ドメイン)名
name: レコード名
type: A / AAAA / CNAME / MX / TXT / SRV / ALIAS
prio: プライオリティー
content: 値
ttl: 60 or 3600 or 7200 or 86400 (無料アカウント、miniプランの場合: 7200からの変更は不可)

Sample
{
     "domain": "dozens.jp",
     "name": "www",
     "type": "A",
     "prio": 10,
     "content": "192.168.1.10",
     "ttl": "7200"
}

Response

レコードリストを返却します。「レコードリストの取得」と同内容

レコードの更新


POST http://dozens.jp/api/record/update/{record_id}.json

record_id: レコードID

Request

prio: プライオリティー
content: 値
ttl: 60 or 3600 or 7200 or 86400 (無料アカウント、miniプランの場合: 7200からの変更は不可)

Sample
{
     "prio": 10,
     "content": "192.168.1.10",
     "ttl": "7200"
}

Response
レコードリストを返却します。「レコードリストの取得」と同内容

レコードの削除


DELETE http://dozens.jp/api/record/delete/{record_id}.json

record_id: レコードID

Response
レコードリストを返却します。「レコードリストの取得」と同内容

エラー(レスポンス)コード

200 : Success

エラーがなかった場合に返却されます。

400 : Bad Request
リクエスト内容に不正な値等があった場合に返却されます。

401 : AuthorizeRequired
未認証のリクエストの場合に返却されます。

404: NotFound
ゾーンIDやレコードIDに該当のモノがなかった場合に返却されます。

500: InternalServerError
サーバー側になんらかのエラーが発生した場合に返却されます。

Sample
{"code":"400","message":"Number of records exceeds the limit."}
※無料ユーザが制限レコード数を超えてレコードを登録使用とした場合

不具合時の連絡先

以下のメールアドレスまでご連絡いただきますよう、お願いいたします。
お問い合わせの際には、ご利用になられているユーザIDをお書き添えください。
support@dozens.jp