Skip to content

Documentation for SparkleAPI

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api

Class Method HTTP request Description
AppVersionApi getAppVersion GET /app/version/get Get App Version
EventBannerGetAllApi getAllEventBanner GET /event_banner/get_all Get All Event Banner (WIP)
InformationGetAllApi getAllInformation GET /information/get_all Get All Information (WIP)
PlayerAbilityApi equipPlayerAbility POST /player/ability/equip Equip Player Ability (WIP)
PlayerAbilityApi releasePlayerAbility POST /player/ability/release Release Player Ability (WIP)
PlayerAbilityApi releaseSlotPlayerAbility POST /player/ability/release_slot Release Slot Player Ability (WIP)
PlayerAbilityApi upgradeSpherePlayerAbility POST /player/ability/upgrade_sphere Upgrade Sphere Player Ability (WIP)
PlayerAchievementApi getAllPlayerAchievement GET /player/achievement/get_all Get All Player Achievement (WIP)
PlayerAchievementApi setPlayerAchievement POST /player/achievement/set Set Player Achievement (WIP)
PlayerAchievementApi shownPlayerAchievement POST /player/achievement/shown Shown Player Achievement (WIP)
PlayerAdvApi addPlayerAdv POST /player/adv/add Add Player Adv (WIP)
PlayerAgeApi setPlayerAge POST /player/age/set Set Player Age (WIP)
PlayerBadgeApi getPlayerBadge GET /player/badge/get Get Player Badge (WIP)
PlayerBattlePartyApi getAllPlayerBattleParty GET /player/battle_party/get_all Get All Player Battle Party (WIP)
PlayerBattlePartyApi setAllPlayerBattleParty POST /player/battle_party/set_all Set All Player Battle Party (WIP)
PlayerBattlePartyApi setNamePlayerBattleParty POST /player/battle_party/set_name Set Name Player Battle Party (WIP)
PlayerCharacterApi evolutionPlayerCharacter POST /player/character/evolution Evolution Player Character (WIP)
PlayerCharacterApi limitbreakPlayerCharacter POST /player/character/limitBreak Limitbreak Player Character (WIP)
PlayerCharacterApi resetAllViewPlayerCharacter POST /player/character/reset_all_view Reset All View Player Character (WIP)
PlayerCharacterApi setAllPlayerCharacterSupport POST /player/character/support/set_all Set All Player Character Support (WIP)
PlayerCharacterApi setNamePlayerCharacterSupport POST /player/character/support/set_name Set Name Player Character Support (WIP)
PlayerCharacterApi setShownPlayerCharacter POST /player/character/set_shown Set Shown Player Character (WIP)
PlayerCharacterApi setViewPlayerCharacter POST /player/character/set_view Set View Player Character (WIP)
PlayerCharacterApi upgradePlayerCharacter POST /player/character/upgrade Upgrade Player Character (WIP)
PlayerChestApi drawPlayerChest POST /player/chest/draw Draw Player Chest (WIP)
PlayerChestApi getAllPlayerChest GET /player/chest/get_all Get All Player Chest (WIP)
PlayerChestApi getStepPlayerChest POST /player/chest/get_step Get Step Player Chest (WIP)
PlayerChestApi resetPlayerChest POST /player/chest/reset Reset Player Chest (WIP)
PlayerContentRoomApi getAllPlayerContentRoomMember POST /player/content_room/member/get_all Get All Player Content Room Member (WIP)
PlayerContentRoomApi setAllPlayerContentRoomMember POST /player/content_room/member/set_all Set All Player Content Room Member (WIP)
PlayerContentRoomApi setShownPlayerContentRoom POST /player/content_room/set_shown Set Shown Player Content Room (WIP)
PlayerExchangeShopApi shownPlayerExchangeShop POST /player/exchange_shop/shown Shown Player Exchange Shop (WIP)
PlayerFavoriteMemberApi getAllPlayerFavoriteMember GET /player/favorite_member/get_all Get All Player Favorite Member (WIP)
PlayerFieldPartyApi getAllPlayerFieldPartyMember GET /player/field_party/member/get_all Get All Player Field Party Member (WIP)
PlayerFieldPartyApi removeAllPlayerFieldPartyMember POST /player/field_party/member/remove_all Remove All Player Field Party Member (WIP)
PlayerFriendApi acceptPlayerFriend POST /player/friend/accept Accept Player Friend (WIP)
PlayerFriendApi cancelPlayerFriend POST /player/friend/cancel Cancel Player Friend (WIP)
PlayerFriendApi getAllPlayerFriend POST /player/friend/get_all Get All Player Friend (WIP)
PlayerFriendApi proposePlayerFriend POST /player/friend/propose Propose Player Friend (WIP)
PlayerFriendApi refusePlayerFriend POST /player/friend/refuse Refuse Player Friend (WIP)
PlayerFriendApi searchPlayerFriend POST /player/friend/search Search Player Friend (WIP)
PlayerFriendApi terminatePlayerFriend POST /player/friend/terminate Terminate Player Friend (WIP)
PlayerGachaApi drawPlayerGacha POST /player/gacha/draw Draw Player Gacha (WIP)
PlayerGachaApi fixPlayerGacha POST /player/gacha/fix Fix Player Gacha (WIP)
PlayerGachaApi getAllPlayerGacha GET /player/gacha/get_all Get All Player Gacha (WIP)
PlayerGachaApi getPlayerGachaBox GET /player/gacha/box/get Get Player Gacha Box (WIP)
PlayerGachaApi pointToCharacterPlayerGacha POST /player/gacha/point_to_character Point To Character Player Gacha (WIP)
PlayerGeneralFlagSaveApi generalFlagSavePlayer POST /player/general_flag_save General Flag Save Player (WIP)
PlayerGetAllApi getAllPlayer GET /player/get_all Get All Player
PlayerItemApi getAllPlayerItemTradeRecipe GET /player/item/trade/recipe/get_all Get All Player Item Trade Recipe (WIP)
PlayerItemApi salePlayerItem POST /player/item/sale Sale Player Item (WIP)
PlayerItemApi tradePlayerItemTrade POST /player/item/trade/trade Trade Player Item Trade (WIP)
PlayerLoginApi loginPlayer POST /player/login Login Player
PlayerLoginBonusApi getPlayerLoginBonus GET /player/login_bonus/get Get Player Login Bonus (WIP)
PlayerMasterOrbApi getAllPlayerMasterOrb GET /player/master_orb/get_all Get All Player Master Orb (WIP)
PlayerMissionApi completePlayerMission POST /player/mission/complete Complete Player Mission (WIP)
PlayerMissionApi getAllPlayerMission GET /player/mission/get_all Get All Player Mission (WIP)
PlayerMissionApi setPlayerMission POST /player/mission/set Set Player Mission (WIP)
PlayerMoveApi getPlayerMove POST /player/move/get Get Player Move (WIP)
PlayerMoveApi setPlayerMove POST /player/move/set Set Player Move (WIP)
PlayerOfferApi completePlayerOffer POST /player/offer/complete Complete Player Offer (WIP)
PlayerOfferApi getAllPlayerOffer GET /player/offer/get_all Get All Player Offer (WIP)
PlayerOfferApi orderPlayerOffer POST /player/offer/order Order Player Offer (WIP)
PlayerPresentApi getAllPlayerPresent GET /player/present/get_all Get All Player Present (WIP)
PlayerPresentApi getPlayerPresent GET /player/present/get Get Player Present (WIP)
PlayerPresentApi getReceivedPlayerPresent GET /player/present/get_received Get Received Player Present (WIP)
PlayerPushNotificationApi setPlayerPushNotification POST /player/push_notification/set Set Player Push Notification (WIP)
PlayerPushTokenApi setPlayerPushToken POST /player/push_token/set Set Player Push Token (WIP)
PlayerQuestApi getAllPlayerQuest GET /player/quest/get_all Get All Player Quest (WIP)
PlayerQuestLogApi completePlayerQuestLog POST /player/quest_log/complete Complete Player Quest Log (WIP)
PlayerQuestLogApi orderPlayerQuestLog POST /player/quest_log/order Order Player Quest Log (WIP)
PlayerQuestLogApi resetPlayerQuestLog POST /player/quest_log/reset Reset Player Quest Log (WIP)
PlayerQuestLogApi retryPlayerQuestLog POST /player/quest_log/retry Retry Player Quest Log (WIP)
PlayerQuestLogApi savePlayerQuestLog POST /player/quest_log/save Save Player Quest Log (WIP)
PlayerResetApi resetPlayer POST /player/reset Reset Player (WIP)
PlayerResumeApi getPlayerResume GET /player/resume/get Get Player Resume (WIP)
PlayerRoomApi getAllPlayerRoom GET /player/room/get_all Get All Player Room (WIP)
PlayerRoomApi setPlayerRoom POST /player/room/set Set Player Room (WIP)
PlayerRoomObjectApi addPlayerRoomObjectLimit POST /player/room_object/limit/add Add Player Room Object Limit (WIP)
PlayerRoomObjectApi buySetPlayerRoomObject POST /player/room_object/buy_set Buy Set Player Room Object (WIP)
PlayerRoomObjectApi salePlayerRoomObject POST /player/room_object/sale Sale Player Room Object (WIP)
PlayerScheduleApi addAllPlayerSchedule POST /player/schedule/add_all Add All Player Schedule (WIP)
PlayerScheduleApi getAllPlayerSchedule POST /player/schedule/get_all Get All Player Schedule (WIP)
PlayerScheduleApi reapDropPlayerSchedule POST /player/schedule/reap_drop Reap Drop Player Schedule (WIP)
PlayerSetApi setPlayer POST /player/set Set Player (WIP)
PlayerSignupApi signupPlayer POST /player/signup Signup Player (WIP)
PlayerStaminaApi addPlayerStamina POST /player/stamina/add Add Player Stamina (WIP)
PlayerStoreApi getAllPlayerStore GET /player/store/get_all Get All Player Store (WIP)
PlayerStoreApi getAllPlayerStorePurchase GET /player/store/purchase/get_all Get All Player Store Purchase (WIP)
PlayerTownApi getAllPlayerTown GET /player/town/get_all Get All Player Town (WIP)
PlayerTownApi setPlayerTown POST /player/town/set Set Player Town (WIP)
PlayerTownFacilityApi addPlayerTownFacilityLimit POST /player/town_facility/limit/add Add Player Town Facility Limit (WIP)
PlayerTownFacilityApi buyAllPlayerTownFacility POST /player/town_facility/buy_all Buy All Player Town Facility (WIP)
PlayerTownFacilityApi gemLevelUpPlayerTownFacility POST /player/town_facility/gem_level_up Gem Level Up Player Town Facility (WIP)
PlayerTownFacilityApi itemUpPlayerTownFacility POST /player/town_facility/item_up Item Up Player Town Facility (WIP)
PlayerTownFacilityApi levelUpPlayerTownFacility POST /player/town_facility/level_up Level Up Player Town Facility (WIP)
PlayerTownFacilityApi openUpPlayerTownFacility POST /player/town_facility/open_up Open Up Player Town Facility (WIP)
PlayerTownFacilityApi salePlayerTownFacility POST /player/town_facility/sale Sale Player Town Facility (WIP)
PlayerTownFacilityApi setAllPlayerTownFacilityBuildPoint POST /player/town_facility/build_point/set_all Set All Player Town Facility Build Point (WIP)
PlayerTrainingApi cancelPlayerTraining POST /player/training/cancel Cancel Player Training (WIP)
PlayerTrainingApi completesPlayerTraining POST /player/training/completes Completes Player Training (WIP)
PlayerTrainingApi getListPlayerTraining POST /player/training/get_list Get List Player Training (WIP)
PlayerTrainingApi ordersPlayerTraining POST /player/training/orders Orders Player Training (WIP)
PlayerTutorialApi addPlayerTutorialStep POST /player/tutorial/step/add Add Player Tutorial Step (WIP)
PlayerTutorialApi addPlayerTutorialTip POST /player/tutorial/tip/add Add Player Tutorial Tip (WIP)
PlayerWeaponApi addPlayerWeaponLimit POST /player/weapon/limit/add Add Player Weapon Limit (WIP)
PlayerWeaponApi evolutionPlayerWeapon POST /player/weapon/evolution Evolution Player Weapon (WIP)
PlayerWeaponApi makePlayerWeapon POST /player/weapon/make Make Player Weapon (WIP)
PlayerWeaponApi receivePlayerWeapon POST /player/weapon/receive Receive Player Weapon (WIP)
PlayerWeaponApi salePlayerWeapon POST /player/weapon/sale Sale Player Weapon (WIP)
PlayerWeaponApi upgradePlayerWeapon POST /player/weapon/upgrade Upgrade Player Weapon (WIP)
QuestChapterGetAllApi getAllQuestChapter GET /quest_chapter/get_all Get All Quest Chapter (WIP)
RoomObjectGetAllApi getAllRoomObject GET /room_object/get_all Get All Room Object (WIP)

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.