認証API

住所録連携API

リソースエンドポイントURL
住所一覧
住所取得
住所登録
住所更新
住所削除
画像一時アップロード
画像取得API

住所

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

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

住所一覧

住所の一覧を取得します。

Permission(Scope): read_address

Request

GET /api/addresses/[group_id]/list
Authorization: Bearer ACCESS_TOKEN
...

パラメータ名	説明	例
group_id	取得するグループのIDを指定	/api/addresses/538be562afc79c2e1c168969/list?limit=10&skip=10
limit [任意]	取得する最大件数を指定します(数字)	/api/addresses/538be562afc79c2e1c168969/list?limit=10&skip=10
skip [任意]	指定した件数をスキップします(数字)	/api/addresses/538be562afc79c2e1c168969/list?limit=10&skip=10
showdeleted [任意]	Tを指定した場合、結果に削除された住所も含めます(T/F)	/api/addresses/538be562afc79c2e1c168969/list?showdeleted=T
updatedmin [任意]	指定した日付以降に変更された住所を取得します(形式:%Y-%m-%dT%H:%M:%S.%fZ, UTC時間)	/api/addresses/538be562afc79c2e1c168969/list?updatedmin=2014-05-27T02%3A10%3A30.455000Z
clientid[任意]	外部IDで絞り込みを行う場合クライアントIDを指定します。	/api/addresses/538be562afc79c2e1c168969/list?clientid=client.app.com
externalid[任意]	外部IDを指定します。client_idが指定されていない場合、無視されます。client_idのみ指定した場合、指定したclient_idが登録されたレコードをすべて取得します。	/api/addresses/538be562afc79c2e1c168969/list?clientid=client.app.com&externalid=abc123
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/addresses/538be562afc79c2e1c168969/list?callback=func_name

Response

HTTP/1.1 200 OK
...

[
    {
        "id":"538be5d1afc79c304c46cef3",
        "group_id":"538be562afc79c2e1c168969",
        "code": "C0014",
        "lastname":"姓",
        "firstname":"名",
        "lastkana":"セイ",
        "firstkana":"メイ",
        "suffix":"敬称",
        "gender":"m",
        "birthdate":"1988-01-01",
        "joint_names":[{
            "lastname":"姓",
            "firstname":"名",
            "lastkana":"セイ",
            "firstkana":"メイ",
            "suffix":"敬称",
            "gender":"m",
            "birthdate":"1988-01-01"
        }, {
            ...
        }],
        "addresses":[
            {
                "kindof":"home",
                "label":"",
                "country":null,
                "zipcode":"000-0000",
                "region":"〇〇県",
                "city":"××市",
                "street":"△町4-5-6",
                "pobox": "",
                "building":"ビル1F",
                "station":"△駅",
                "geolocation": "111.11, 222.22"
            }, {
                ...
            }
        ],
        "organization":{
            "name":"(株)てすと",
            "kana":"カブシキガイシャテスト",
            "dept1":"開発事業部",
            "dept2":"開発２部１課",
            "title":"課長"
        },
        "tags":["タグ1", ..., "タグn"],
        "weburls":[{"kindof": "prof", "label":"", "url":"http://test.com/"}],
        "emails":[{
            "kindof": "cell", "address": "test@test.com",
            "label":""
        }, {
            ...
        }],
        "telephones":[{
            kindof": "cell", "number": "090-6666-6666",
            "label":""
        }, {
            ...
        }],
        "memo":"メモ\n改行もOK",
        "face_picture": {
            "image": "538be5d1afc79c305b544551",
            "image_size": [1000, 1000],
            "thumb_size": [200, 200],
            "exif": {"taken": "2013-01-01T09:00:00.000000Z"}
        },
        "pictures": [{
            "image": "538be5d1afc79c305b544552",
            "image_size": [1000, 500],
            "thumb_size": [200, 200],
            "exif": {"taken": "2013-01-02T09:00:00.000000Z"}
        ]},
        "extendprops":[{
            "client_id": "client_id.test.com",
            "data": {"key": "value"}
        }, {
            ...
        }],
        "external_ids":[{
            "client_id": "client_id.test.com",
            "id": "oijfK+Knfdf"
        }],
        "etag":"46b06de4ea0011e39c6f000c29612a68",
        "deleted":false,
        "created_at":"2014-06-02T02:47:45.808057Z",
        "updated_at":"2014-06-02T02:47:45.808057Z",
        "created_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
        "updated_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
        "owner_id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh"
    }, {
        ...
    }
]

項目名	説明
val[i].id	住所ID
val[i].group_id	グループID
val[i].code	顧客コード
val[i].lastname	姓
val[i].firstname	名
val[i].lastkana	姓(カナ)
val[i].firstkana	名(カナ)
val[i].suffix	敬称
val[i].gender	性別(男:m/女:f)
val[i].birthdate	誕生日(形式:%Y-%m-%d)
val[i].joint_names[j]	連名
val[i].joint_names[j].lastname	連名 – 姓
val[i].joint_names[j].firstname	連名 – 名
val[i].joint_names[j].lastkana	連名 – 姓(カナ)
val[i].joint_names[j].firstkana	連名 – 名
val[i].joint_names[j].honorific	連名 – 敬称
val[i].joint_names[j].gender	連名 – 性別(男:m/女:f)
val[i].joint_names[j].birthdate	連名 – 誕生日(形式:%Y-%m-%d)
val[i].addresses[j]	住所
val[i].addresses[j].kindof	住所 – 種別(自宅:home/会社:office/その他:null)
val[i].addresses[j].label	住所 – 種別にその他が選択された場合のラベル
val[i].addresses[j].country	住所 – 国名
val[i].addresses[j].zipcode	住所 – 郵便番号
val[i].addresses[j].region	住所 – 都道府県
val[i].addresses[j].city	住所 – 市区町村
val[i].addresses[j].street	住所 – 地区番地
val[i].addresses[j].pobox	住所 – 私書箱
val[i].addresses[j].building	住所 – ビル名
val[i].addresses[j].station	住所 – 最寄り駅
val[i].addresses[j].geolocation	住所 – 位置情報(形式:’latitude, longitude’)
val[i].organization.name	会社名
val[i].organization.kana	会社名(カナ)
val[i].organization.dept1	部署1
val[i].organization.dept2	部署2
val[i].organization.title	役職
val[i].tags[j]	タグ情報
val[i].weburls[j]	URL
val[i].weburls[j].kindof	URL – 種別(プロフィール:profile/ブログ:blog/ホームページ:hp/会社:office/その他:null)
val[i].weburls[j].label	URL – 種別にその他が選択された場合のラベル
val[i].weburls[j].url	URL – サイトURL
val[i].emails[j]	メール
val[i].emails[j].kindof	メール – 種別(携帯:cell/自宅:home/会社:office)
val[i].emails[j].label	メール – 種別にその他が選択された場合のラベル
val[i].emails[j].address	メール – アドレス
val[i].telephones[j]	電話
val[i].telephones[j].kindof	電話 – 種別(自宅TEL:tel/自宅FAX:fax/個人携帯:cell/会社TEL:offtel/会社FAX:offfax/会社携帯:offcell/その他:null)
val[i].telephones[j].label	電話 – 種別にその他が選択された場合のラベル
val[i].telephones[j].number	電話 – 番号
val[i].memo	メモ複数行
val[i].face_picture	顔写真画像
val[i].face_picture.image	顔写真画像 – 画像ID
val[i].face_picture.image_size	顔写真画像 – 画像サイズ
val[i].face_picture.thumb_size	顔写真画像 – サムネイル画像サイズ
val[i].face_picture.exif.taken	顔写真画像 – Exif – 撮影日時
val[i].pictures[j]	写真画像
val[i].pictures[j].image	写真画像 – 画像ID
val[i].pictures[j].image_size	写真画像 – 画像サイズ
val[i].pictures[j].thumb_size	写真画像 – サムネイル画像サイズ
val[i].pictures[j].exif.taken	写真画像 – Exif – 撮影日時
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].id	外部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

住所取得

住所を取得します。 ※注意！削除されているレコードも取得できますが、将来的にNot Foundを返すように仕様変更する予定です。

Permission(Scope): read_address

Request

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

パラメータ名	説明	例
id	取得する住所のIDを指定	/api/address/538be5d1afc79c304c46cef3
callback [任意]	JSONP使用する場合コールバック関数名を指定します	/api/address/538be5d1afc79c304c46cef3?callback=func_name

Response

HTTP/1.1 200 OK
...

{
    "id":"538be5d1afc79c304c46cef3",
    "group_id":"538be562afc79c2e1c168969",
    "code":"C0014",
    "lastname":"姓",
    "firstname":"名",
    "lastkana":"セイ",
    "firstkana":"メイ",
    "suffix":"敬称",
    "gender":"m",
    "birthdate":"1988-01-01",
    "joint_names":[{
        "lastname":"姓",
        "firstname":"名",
        "lastkana":"セイ",
        "firstkana":"メイ",
        "suffix":"敬称",
        "gender":"m",
        "birthdate":"1988-01-01"
    }, {
        ...
    }],
    "addresses":[
        {
            "kindof":"home",
            "label":"",
            "country":null,
            "zipcode":"000-0000",
            "region":"〇〇県",
            "city":"××市",
            "street":"△町4-5-6",
            "pobox":"",
            "building":"ビル1F",
            "station":"△駅",
            "geolocation": "111.11, 222.22"
        }, {
            ...
        }
    ],
    "organization":{
        "name":"(株)てすと",
        "kana":"カブシキガイシャテスト",
        "dept1":"開発事業部",
        "dept2":"開発２部１課",
        "title":"課長"
    },
    "tags":["タグ1", ..., "タグn"],
    "weburls":[{"kindof": "prof", "label":"", "url":"http://test.com/"}],
    "emails":[{
        "kindof": "cell", "address": "test@test.com",
        "label":""
    }, {
        ...
    }],
    "telephones":[{
        "kindof": "cell", "number": "090-6666-6666",
        "label":""
    }, {
        ...
    }],
    "memo":"メモ\n改行もOK",
    "face_picture": {
        "image": "538be5d1afc79c305b544551",
        "image_size": [1000, 1000],
        "thumb_size": [200, 200],
        "exif": {"taken": "2013-01-01T09:00:00.000000Z"}
    },
    "pictures": [{
        "image": "538be5d1afc79c305b544552",
        "image_size": [1000, 500],
        "thumb_size": [200, 200],
        "exif": {"taken": "2013-01-02T09:00:00.000000Z"}
    ]},
    "extendprops":[{
        "client_id": "client_id.test.com",
        "data": {"key": "value"}
    }, {
        ...
    }],
    "external_ids":[{
        "client_id": "client_id.test.com",
        "id": "oijfK+Knfdf"
    }],
    "etag":"46b06de4ea0011e39c6f000c29612a68",
    "deleted":false,
    "created_at":"2014-06-02T02:47:45.808057Z",
    "updated_at":"2014-06-02T02:47:45.808057Z",
    "created_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
    "updated_by":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh",
    "owner_id":"AAz5XJcjitOEm7gDMu+SEhIZKAcXCsLdmyYLxciABrLh"
}

住所登録

住所を新たに登録します。

Permission(Scope): read_address, write_address

Request

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


{
    "group_id":"538be562afc79c2e1c168969",
    "code":"C0014",
    "lastname":"姓",
    "firstname":"名",
    "lastkana":"セイ",
    "firstkana":"メイ",
    "suffix":"敬称",
    "gender":"m",
    "birthdate":"1988-01-01",
    "joint_names":[{
        "lastname":"姓",
        "firstname":"名",
        "lastkana":"セイ",
        "firstkana":"メイ",
        "suffix":"敬称",
        "gender":"m",
        "birthdate":"1988-01-01"
    }, {
        ...
    }],
    "addresses":[
        {
            "kindof":"home",
            "label":"",
            "country":null,
            "zipcode":"000-0000",
            "region":"〇〇県",
            "city":"××市",
            "street":"△町4-5-6",
            "pobox":"",
            "building":"ビル1F",
            "station":"△駅",
            "geolocation": "111.11, 222.22"
        }, {
            ...
        }
    ],
    "organization":{
        "name":"(株)てすと",
        "kana":"カブシキガイシャテスト",
        "dept1":"開発事業部",
        "dept2":"開発２部１課",
        "title":"課長"
    },
    "tags":["タグ1", ..., "タグn"],
    "weburls":[{"kindof": "prof", "label":"", "url":"http://test.com/"}],
    "emails":[{
        "kindof": "cell", "address": "test@test.com",
        "label":""
    }, {
        ...
    }],
    "telephones":[{
        kindof": "cell", "number": "090-6666-6666",
        "label":""
    }, {
        ...
    }],
    "memo":"メモ\n改行もOK",
    "face_picture": {
        "image": "538be5d1afc79c305b544551",
        "source": "temp"
    },
    "pictures": [{
        "image": "538be5d1afc79c305b544552"
    ]},
    "extendprop":{
        "client_id": "client_id.test.com",
        "data": {"key": "value"}
    },
    "external_id":{
        "client_id": "client_id.test.com",
        "id": "oijfK+Knfdf"
    }
}

項目名	説明
val.group_id	グループID[必須]
val.code	顧客コード
val.lastname	姓
val.firstname	名
val.lastkana	姓(カナ)
val.firstkana	名(カナ)
val.suffix	敬称
val.gender	性別(男:m/女:f)
val.birthdate	誕生日(形式:%Y-%m-%d)
val.joint_names[j]	連名
val.joint_names[j].lastname	連名 – 姓
val.joint_names[j].firstname	連名 – 名
val.joint_names[j].lastkana	連名 – 姓(カナ)
val.joint_names[j].firstkana	連名 – 名
val.joint_names[j].honorific	連名 – 敬称
val.joint_names[j].gender	連名 – 性別(男:m/女:f)
val.joint_names[j].birthdate	連名 – 誕生日(形式:%Y-%m-%d)
val.addresses[j]	住所
val.addresses[j].kindof	住所 – 種別(自宅:home/会社:office/その他:null)
val.addresses[j].label	住所 – 種別にその他が選択された場合のラベル
val.addresses[j].country	住所 – 国名
val.addresses[j].zipcode	住所 – 郵便番号
val.addresses[j].region	住所 – 都道府県
val.addresses[j].city	住所 – 市区町村
val.addresses[j].street	住所 – 地区名番地
val.addresses[j].pobox	住所 – 私書箱
val.addresses[j].building	住所 – ビル名
val.addresses[j].station	住所 – 最寄り駅
val.addresses[j].geolocation	住所 – 位置情報(形式:’latitude, longitude’)
val.organization.name	会社名
val.organization.kana	会社名(カナ)
val.organization.dept1	部署1
val.organization.dept2	部署2
val.organization.title	役職
val.tags[j]	タグ情報
val.weburls[j]	URL
val.weburls[j].kindof	URL – 種別(プロフィール:profile/ブログ:blog/ホームページ:hp/会社:office/その他:null)
val.weburls[j].label	URL – 種別にその他が選択された場合のラベル
val.weburls[j].url	URL – サイトURL
val.emails[j]	メール
val.emails[j].kindof	メール – 種別(携帯:cell/自宅:home/会社:office)
val.emails[j].label	メール – 種別にその他が選択された場合のラベル
val.emails[j].address	メール – アドレス
val.telephones[j]	電話
val.telephones[j].kindof	電話 – 種別(自宅TEL:tel/自宅FAX:fax/個人携帯:cell/会社TEL:offtel/会社FAX:offfax/会社携帯:offcell/その他:null)
val.telephones[j].label	電話 – 種別にその他が選択された場合のラベル
val.telephones[j].number	電話 – 番号
val.memo	メモ複数行
val.face_picture	顔写真画像
val.face_picture.image	顔写真画像 – 画像ID
val.face_picture.source	顔写真画像 – ソース(tempを指定)
val.pictures[j]	写真画像
val.pictures[j].image	写真画像 – 画像ID(更新する場合は、一時アップロード画像IDを指定ｈ)
val.pictures[j].source	写真画像 – ソース(更新する場合は、tempを指定)
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

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

Response

※住所取得のレスポンスと同じ

住所更新

登録済みの住所を更新します。 ※削除されているレコードも更新できますが、将来的にNot Foundを返すように仕様変更する予定です。

Permission(Scope): read_address, write_address

Request

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

{
    ...(JSONフォーマットは登録と同様)
}

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

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

Response

※住所取得のレスポンスと同じ

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

住所削除

登録済みの住所を削除します。 ※注意！既に削除されているレコードも削除できますが、将来的にNot Foundを返すように仕様変更する予定です。

Permission(Scope): read_address, write_address

Request

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

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

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

Response

※住所取得のレスポンスと同じ

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

画像一時アップロード

住所登録・更新に使用する画像ファイルをサーバにアップロードします。このAPIでアップロードした一時画像IDを使用して、住所や自宅住所の写真データの登録や更新を行うことができます。

Permission(Scope):

Request

POST /api/temp/photo
Authorization: Bearer ACCESS_TOKEN
Content-Type: multipart/form-data; boundary=....

Content-Disposition: form-data; name="source"
....

パラメータ名	説明	例
source	画像ファイル（multipart/form-data）

Response

項目名	説明
id	一時画像ID
source	temp固定
image_size[0]	再圧縮後の画像の幅
image_size[1]	再圧縮後の画像の高さ
thumb_size[0]	サムネイル画像の幅
thumb_size[1]	サムネイル画像の高さ
exif.taken	撮影日時

画像取得API

住所に紐付いた画像データを取得します。

Permission(Scope): read_address

Request

GET /api/address/photo/[id]/[picture]
Authorization: Bearer ACCESS_TOKEN

パラメータ名	説明	例
id	住所IDを指定します
picture	画像IDを指定します

Response

画像ファイル(image/jpeg)

認証API

住所録連携API

住所

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

住所一覧

住所取得

住所登録

住所更新

住所削除

画像一時アップロード

画像取得API

筆まめクラウド

筆まめクラウド住所録

Web筆まめ

Web筆まめアプリ

関連サイト