認証API

住所録連携API

郵便番号辞書
グループ(住所録)

リソースエンドポイントURL
グループ一覧
グループ取得
グループ登録
グループ更新
グループ削除
グループ共有設定解除

住所
自宅住所
バッチ処理
レコードの受信

グループ(住所録)

リソースエンドポイントURL

Production: https://account.fudemame.jp/api/
Staging: http://account-stg.fudemame.jp/api/

グループ一覧

グループの一覧を取得します。
Permission(Scope): read_address

Request

GET /api/groups/list
Authorization: Bearer ACCESS_TOKEN
...

パラメータ名	説明	例
limit [任意]	取得する最大件数を指定します(数字)	/api/groups/list?limit=10&skip=10
skip [任意]	指定した件数をスキップします(数字)	/api/groups/list?limit=10&skip=10
showdeleted [任意]	Tを指定した場合、結果に削除されたグループも含めます(T/F)	/api/groups/list?showdeleted=T
updatedmin [任意]	指定した日付以降に変更されたグループを取得します(形式:%Y-%m-%dT%H:%M:%S.%fZ, UTC時間)	/api/groups/list?updatedmin=2014-05-27T02%3A10%3A30.455000Z
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/groups/list?callback=func_name

Response

HTTP/1.1 200 OK
...

[
    {
        "updated_by":null,
        "color":null,
        "icon":null,
        "use":"priv",
        "updated_at":null,
        "id":"5382faedafc79c524771f3d3",
        "users":[{"allow_edit_address":false,"id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh","allow_edit_group":false}],
        "name":"groupname",
        "created_at":"2014-05-26T08:27:25.872000Z",
        "created_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
        "deleted":false,
        "etag":"914309e4e4af11e39948000c29612a68",
        "extendprops":[{"data":null,"client_id":"implicit.calico.jp"}],
        "external_ids":[{
            "client_id": "implicit.calico.jp",
            "id": "oijfK+Knfdf"
        }],
        "owner_id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh"
    }, {
        ...
    }
]

項目名	説明
val[i].id	グループID
val[i].name	グループ名
val[i].color	色(RRGGBB形式, デフォルトの場合null)
val[i].icon	アイコンID
val[i].use	用途区分
val[i].users[j]	共有設定
val[i].users[j].id	共有設定 – ユーザID
val[i].users[j].allow_edit_group	共有設定 – グループ編集権限
val[i].users[j].allow_edit_address	共有設定 – 住所録編集権限
val[i].extendprops[j]	クライアント拡張情報
val[i].extendprops[j].client_id	拡張情報 – 登録アプリケーションID
val[i].extendprops[j].data	拡張情報 – データ
val[i].external_ids[j]	アプリケーション外部ID(同期時のキーに使用すること)
val[i].external_ids[j].client_id	外部ID – 登録アプリケーションID
val[i].external_ids[j].data	外部ID – ID
val[i].etag	ETag
val[i].deleted	削除されている場合true
val[i].created_at	作成日時[UTC]
val[i].updated_at	変更日時[UTC]
val[i].created_by	作成者ID
val[i].updated_by	変更者ID
val[i].owner_id	所有者ID

グループ取得

グループを取得します。

Permission(Scope): read_address

Request

GET /api/group/[id]
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
...

パラメータ名	説明	例
id	グループIDを指定します	/api/group/5382faedafc79c524771f3d3
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/group/5382faedafc79c524771f3d3?callback=func_name

Response

HTTP/1.1 200 OK
...

{
    "updated_by":null,
    "color":null,
    "icon":null,
    "use":"private",
    "updated_at":null,
    "id":"5382faedafc79c524771f3d3",
    "users":[{"allow_edit_address":false,"id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh","allow_edit_group":false}],
    "name":"groupname",
    "created_at":"2014-05-26T08:27:25.872000Z",
    "created_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
    "deleted":false,
    "etag":"914309e4e4af11e39948000c29612a68",
    "extendprops":[{"data":null,"client_id":"implicit.calico.jp"}],
    "external_ids":[{
        "client_id": "implicit.calico.jp",
        "id": "oijfK+Knfdf"
    }],
    "summary": {"count": 11},
    "owner_id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh"
}

項目名	説明
val.id	グループID
val.name	グループ名
val.color	色(RRGGBB形式, デフォルトの場合null)
val.icon	アイコンID
val.use	用途区分
val.users[i]	共有設定
val.users[i].id	共有設定 – ユーザID
val.users[i].allow_edit_group	共有設定 – グループ編集権限
val.users[i].allow_edit_address	共有設定 – 住所録編集権限
val.extendprops[i]	アプリケーション拡張情報
val.extendprops[i].client_id	拡張情報 – 登録アプリケーションID
val.extendprops[i].data	拡張情報 – データ
val.external_ids[i]	アプリケーション外部ID(同期時のキーに使用すること)
val.external_ids[i].client_id	外部ID – 登録アプリケーションID
val.external_ids[i].id	外部ID – ID
val.summary.count	集計情報 – 登録された住所レコード数
val.etag	ETag
val.deleted	削除されている場合true
val.created_at	作成日時[UTC]
val.updated_at	変更日時[UTC]
val.created_by	作成者ID
val.updated_by	変更者ID
val.owner_id	所有者ID

グループ登録

グループを新たに登録します。

Permission(Scope): read_address, write_address

Request

POST /api/group/
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
...

{
    "name":"groupname",
    "color":"EFAAE0",
    "icon":"home",
    "use":"corp",
    "users":[{"allow_edit_address":false,"id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh","allow_edit_group":false}],
    "extendprop": {"client_id":"implicit.calico.jp | data":{"testkey": "testvalue"}},
    "external_id": {"client_id":"implicit.calico.jp | id":"oijfK+Knfdf"}
}

パラメータ名	説明	例
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/group/?callback=func_name

項目名	説明
val.name	グループ名
val.color	色(RRGGBB形式, デフォルトの場合null)
val.icon	アイコンID
val.use	用途区分
val.users[i]	共有設定(デフォルトの場合null)
val.users[i].id	共有設定 – ユーザID
val.users[i].allow_edit_group	共有設定 – グループ編集権限
val.users[i].allow_edit_address	共有設定 – 住所録編集権限
val.extendprop	アプリケーション拡張情報
val.extendprop.client_id	拡張情報 – 登録アプリケーションID
val.extendprop.data	拡張情報 – データ
val.external_id	アプリケーション外部ID
val.external_id.client_id	外部ID – 登録アプリケーションID
val.external_id.id	外部ID – ID

Response

※グループ取得のレスポンスと同じ

グループ更新

登録済みのグループを更新します。

Permission(Scope): read_address, write_address

Request

PUT /api/group/[id]
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
If-Match: 914309e4e4af11e39948000c29612a68
...

{
    "name":"groupname",
    "color":"EFAAE0",
    "icon":"home",
    "use":"corp",
    "users":[{"allow_edit_address":false,"id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh","allow_edit_group":false}],
    "extendprop": {"client_id":"implicit.calico.jp | data":{"testkey": "testvalue"}},
    "external_id": {"client_id":"implicit.calico.jp | id":"oijfK+Knfdf"}
}

※If-Match: Etagは登録時にデータの衝突を検知したい場合のみ設定

パラメータ名	説明	例
id	グループIDを指定します	/api/group/5382faedafc79c524771f3d3
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/group/5382faedafc79c524771f3d3?callback=func_name

項目名	説明
val.name [必須]	グループ名
val.color	色(RRGGBB形式, デフォルトの場合null)
val.icon	アイコンID
val.use	用途区分
val.users[i]	共有設定
val.users[i].id	共有設定 – ユーザID
val.users[i].allow_edit_group	共有設定 – グループ編集権限
val.users[i].allow_edit_address	共有設定 – 住所録編集権限
val.extendprop	アプリケーション拡張情報
val.extendprop.client_id	拡張情報 – 登録アプリケーションID
val.extendprop.data	拡張情報 – データ
val.external_id	アプリケーション外部ID(同期時のキーに使用すること)
val.external_id.client_id	外部ID – 登録アプリケーションID
val.external_id.id	外部ID – ID

Response

※グループ取得のレスポンスと同じ

更新リクエストヘッダー(If-Match)のetagと現在のサーバのetagが異なる場合ステータスコード:412 Precondition Failed が返され、更新処理がキャンセルされます。

グループ削除

登録済みのグループを削除します。

Permission(Scope): read_address, write_address

Request

DELETE /api/group/[id]
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
If-Match: 914309e4e4af11e39948000c29612a68
...

※If-Match: Etagは登録時にデータの衝突を検知したい場合のみ設定

パラメータ名	説明	例
id	グループIDを指定します	/group/5382faedafc79c524771f3d3
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/group/5382faedafc79c524771f3d3?callback=func_name

Response

※グループ取得のレスポンスと同じ

削除リクエストヘッダー(If-Match)のetagと現在のサーバのetagが異なる場合ステータスコード:412 Precondition Failed が返され、更新処理がキャンセルされます。

グループ共有設定解除

自分が所有しているグループから共有ユーザを外し、自分が共有ユーザとなっているグループから自分を外します。

Permission(Scope): read_address, write_address

Request

GET /api/groups/unshare
Authorization: Bearer ACCESS_TOKEN
...

パラメータ名	説明	例
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/groups/unshare?callback=func_name

Response

※グループ一覧取得のレスポンスと同じ

認証API

住所録連携API

グループ(住所録)

リソースエンドポイントURL

グループ一覧

グループ取得

グループ登録

グループ更新

グループ削除

グループ共有設定解除

筆まめクラウド

筆まめクラウド住所録

Web筆まめ

Web筆まめアプリ

関連サイト