ジャンクエ外部API 利用ガイド

ジャンクエアカウントを使って、外部ゲームからユーザー情報・ガチャカード情報・クエストポイント・ゲーム実績ポイントを連携できます。

まず最初に

APIキーは、ジャンクエにログインしているユーザーのみ発行できます。 1つのジャンクエアカウントにつき、発行できるAPIキーは1つだけです。

APIキーを発行・確認する

できること

  • ユーザー情報の取得
  • 既存ガチャカード一覧の取得
  • クエストポイントの加算
  • ゲーム実績ポイントの加算

できないこと

  • ガチャチケット付与
  • クーポン発行
  • 課金残高の変更
  • 所持カードの変更
  • パスワード情報の取得

API URL

https://kinenbi.wasimiya.com/mission/external_api/api.php

共通ルール

送信方法 POST
形式 JSON
必須 api_key と action
ユーザー指定 member_qr_key を使います

1. ユーザー情報取得

member_qr_key に一致するジャンクエユーザーの名前、クエストポイント、ゲーム実績ポイントを取得します。 

fetch("https://kinenbi.wasimiya.com/mission/external_api/api.php", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    api_key: "発行されたAPIキー",
    action: "get_user",
    member_qr_key: "ユーザーのmember_qr_key"
  })
})
.then(r => r.json())
.then(console.log);

返り値例

{
  "ok": true,
  "user": {
    "name": "kaz",
    "avatar": "u1.png",
    "points": 10,
    "game_score": 5
  }
}

2. 既存ガチャカード一覧取得

登録済みのガチャカード一覧を取得します。カードを配布したり、所持カードを変更したりする機能ではありません。 

fetch("https://kinenbi.wasimiya.com/mission/external_api/api.php", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    api_key: "発行されたAPIキー",
    action: "get_cards"
  })
})
.then(r => r.json())
.then(console.log);

3. クエストポイント加算

ユーザーデータ内の points を加算します。 直接数値を変更するのではなく、指定した数だけ増やす方式です。 

fetch("https://kinenbi.wasimiya.com/mission/external_api/api.php", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    api_key: "発行されたAPIキー",
    action: "add_points",
    member_qr_key: "ユーザーのmember_qr_key",
    value: 1
  })
})
.then(r => r.json())
.then(console.log);

4. ゲーム実績ポイント加算

ユーザーデータ内の game_score を加算します。 クリア回数、実績、ミニゲーム記録などに使えます。 

fetch("https://kinenbi.wasimiya.com/mission/external_api/api.php", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    api_key: "発行されたAPIキー",
    action: "add_game_score",
    member_qr_key: "ユーザーのmember_qr_key",
    value: 1
  })
})
.then(r => r.json())
.then(console.log);

安全対策

このAPIでは、クーポン・課金残高・ガチャチケット・所持カードは操作できません。 また、ポイント加算には1回ごと・1日ごとの上限があります。

APIキーを悪用した場合、キーが停止される場合があります。

よくあるエラー

invalid_json JSON形式で送信されていません。ブラウザで直接開いた場合もこの表示になります。
api_key_required APIキーが送信されていません。
invalid_api_key APIキーが間違っている、または停止されています。
member_qr_key_required ユーザー指定用の member_qr_key がありません。
user_not_found member_qr_key に一致するユーザーが見つかりません。
invalid_value 加算値が不正、または1回の上限を超えています。

外部ゲーム制作者に渡す情報

ご希望があれば今後、ジャンクエとＳＤＫ化して「ＲＰＧ」「深森めもりＡＩ」「ゴリアン（暗号通貨）」「ワードウルフ」・・などの全てのコンテンツと連動できるように致します。

ジャンクエ外部API / Jungle Kinenbi