レコードの受信

筆まめクラウド > 筆まめクラウド住所録API > レコードの受信

認証API

住所録連携API

レコードの受信

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

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

受信レコード一覧取得

受信レコードの一覧を取得します。

Permission(Scope): read_address

Request

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

Response

HTTP/1.1 200 OK
...

{
    "read": false,
    "message": "This is test message",
    "face": null,
    "fullname": "test",
    "created_at": "2015-06-30T07:56:36Z",
    "email": " (test@creo.co.jp)",
    "id": "55924bb473f7cf29d3717253",
    "kananame": ""
},...
項目名 説明
val.read 既読済みならばtrue、未読ならばfalse
val.message メッセージ
val.face 顔写真
val.fullname 姓名
val.created_at 作成日時[UTC]
val.email e-mail アドレス
val.id 受信レコードID
val.kananame 姓名(カナ)

受信レコードを既読に設定

受信レコードを既読に設定します。

Permission(Scope): read_address, write_address

Request

GET /api/received_read/{id}
Authorization: Bearer ACCESS_TOKEN
...
パラメータ名 説明 例
id 受信レコードIDを指定します /api/received_read/55924bb473f7cf29d3717253
callback [任意] JSONP使用する場合コールバック関数名を指定します /api/received_read/55924bb473f7cf29d3717253?callback=func_name

Response

null

住所レコードの取得

住所レコードを取得します。

Permission(Scope): read_address

Request

GET /api/received_address/[id]
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
...
パラメータ名 説明 例
id 取得する住所のIDを指定 /api/received_address/5382faedafc79c524771f3d3
callback [任意] JSONP使用する場合コールバック関数名を指定します /api/received_address/5382faedafc79c524771f3d3?callback=func_name

Response

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

受信レコードの削除

受信レコードを削除します。

Permission(Scope): read_address, write_address

Request

DELETE /api/received_address/[id]
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json; charset=UTF-8;
...
パラメータ名 説明 例
id 削除する住所を指定します /api/received_address/5382faedafc79c524771f3d3
callback [任意] JSONP使用する場合コールバック関数名を指定します /api/received_address/5382faedafc79c524771f3d3?callback=func_name

Response

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

住所の送信

レコードを送信します。

Permission(Scope): read_address, write_address

Request

POST /api/send_address
Authorization: Bearer ACCESS_TOKEN
...
項目名 説明
val.id 送信住所のID
val.userid 送信相手のUserID
val.email 送信相手のemailアドレス
val.message メッセージ内容
val.notify 送信相手にお知らせメールを送るならば1、送らないならば0
val.push 送信相手にpush通知を送るならば1、送らないならば0

Response

{}

画像取得API

自宅住所の画像取得APIを使います。

自宅住所 画像取得API