アカウントプロフィールの取得と更新

はじめに

FlipLinkアカウントのプロフィール(表示名、電話番号、プロフィール画像)を取得し、部分更新の呼び出しでこれらのフィールドを更新できます。

このディスカッションで使うAPI

このガイドに誤りや古い情報がありますか?

できること

アカウントには小さなプロフィールがあります。表示名、電話番号、プロフィール画像のURLです。APIでは、これらの値を取得したり、いずれかを更新したりできます。

始める前に

  • APIキーで認証します(認証を参照)。
  • ベースURL: https://go.fliplink.me

プロフィールを取得する

GET /api/get-profileは、そのAPIキーの現在のプロフィールを返します。

curl -X GET 'https://go.fliplink.me/api/get-profile' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{ "Result": "OK", "Name": "Your Account", "Phone": "", "ProfileImage": "" }

プロフィールを更新する

PUT /api/set-profile部分更新です。省略したフィールドは既存の値を保持し、少なくとも1つのフィールドを送る必要があります。ボディはform-urlencoded形式です。

フィールド設定される内容
Name表示名
Phone電話番号
ProfileImageプロフィール画像のURL
curl -X PUT 'https://go.fliplink.me/api/set-profile' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Name=Mark Stevens' \
  --data-urlencode 'Phone=+14155550142' \
  --data-urlencode 'ProfileImage=https://example.com/me.jpg'

レスポンス:

{ "Result": "OK", "Message": "Updated successfully" }

1つのフィールドだけを変更するには、そのフィールドだけを送ってください。他のフィールドはそのまま残ります。

起こりうるエラー

  • APIキーが欠けているか無効な場合 → HTTP 401、プレーンなUnauthorized HTMLページで、JSONボディはありません
  • ボディのフィールド名のスペルミス → HTTP 200{ "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }

関連ディスカッション