プロファイル API

プロフィールAPIは、コンソールのコミュニティで「コミュニティプロフィール」だけを独立して運営する場合や「ゲームプロフィール」を「コミュニティプロフィール」と連携する場合に使用します。

事前準備¶

コンソールでコミュニティプロフィールをクリックして、使用したいプロフィールタイプに応じて連携するAPIを登録する必要があります。

• コミュニティプロフィールのみ使用する場合、基本プロフィール画像API の登録
• ゲームプロフィール連携時、ゲームプロフィールAPI の登録

詳細については、コンソールのプロフィールAPI連携を参照してください。

基本プロファイル画像API¶

基本プロフィール画像APIは、以下のようにコミュニティプロフィールタイプでコミュニティプロフィールのみを使用する場合、基本プロフィール画像を変更する際に使用します。

基本プロフィール画像APIをリクエストすると、サーバーでは**02:00 (KST)**にバッチプログラムでヘッディングAPIを照会し、プロフィール情報を更新します。(商用、サンドボックス共通)

プロフィール画像のサイズ規定は以下の通りです。

• 最小160 x 160px
• 正方形比率の形
• コーナーの値と境界線のアウトラインは基本的に適用されます

リクエストURL¶

リクエストボディ¶

• メソッドタイプ: POST
• パラメータ
  • パラメータはありません

レスポンスボディ¶

• データタイプ: Json

• パラメータ

  名前	説明	TYPE	value値
  result	結果値	JSONオブジェクト
  result.code	結果コード (100 : 成功)	整数	100
  result.msg	結果メッセージ	文字列
  params	パラメータ	JSONオブジェクト
  params.total	リストの数	int	10
  params.list	リスト（画像URL）	文字列 Away	["https://test-img.co.kr/profile1.jpg","https://test-img.co.kr/profile2.jpg" ...]

レスポンスコード¶

• 成功は必ず100で伝えてください。

応答サンプル¶

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params":{
        "total": 10,
        "list":[
                "https://test-img.co.kr/profile1.jpg",
                "https://test-img.co.kr/profile2.jpg",
                "https://test-img.co.kr/profile3.jpg",
                ……
                "https://test-img.co.kr/profile10.jpg"
        ]
    }
}

ゲームプロフィールAPI¶

ゲームプロフィールAPIは、コミュニティプロフィールをゲームプロフィールと同じように連携する場合に使用します。

ゲームプロフィールと連動したコミュニティプロフィールは、コミュニティ管理者がコミュニティにログインする際に更新されます。

リクエストURL¶

リクエストボディ¶

• メソッドタイプ: POST

• パラメータ

  フィールド名	説明	タイプ	必須かどうか
  pid	ユーザーのPlayerID	string	Y

リクエストサンプル¶

{
    "pid" : "20000010000"
}

レスポンスボディ¶

• データタイプ: Json

• パラメータ

  名前	説明	タイプ	値
  result	結果値	JSONオブジェクト
  result.code	結果コード (100:成功)	整数	100
  result.msg	結果メッセージ	文字列
  params	パラメーター	JSONオブジェクト
  params.pid	ユーザーのPlayerID	文字列	20000010000
  params.nickname	ユーザーのニックネーム	文字列	洪吉童
  params.p_image	ユーザーのプロフィール画像URL	文字列	https://test-img.co.kr/profile1.jpg

レスポンスコード¶

レスポンスサンプル¶

{
    "result": {
        "code": 100,
        "msg": "success"
    },
    "params": {
        "pid": "20000010000",
        "nickname": "홍길동",
        "p_image": "https://test-img.co.kr/profile1.jpg"
    }
}