Artifacts MMO – PHP SDK

Artifacts is an API-based MMO game where you can manage 5 characters to explore, fight, gather resources, craft items and much more.

Website: https://artifactsmmo.com/

Documentation: https://docs.artifactsmmo.com/

OpenAPI Spec: https://api.artifactsmmo.com/openapi.json

Installation

Requirements

PHP 8.1 and later.

Composer

composer require ryanbeiden/artifactsmmo-php

Getting Started

Authorization

/** @var ArtifactsMmo\Configuration */
Configuration::getDefaultConfiguration(
    ->setHost(config('artifacts.host'))
    ->setAccessToken(config('artifacts.token'));

• Artifacts Host (i.e. https://api.artifactsmmo.com)
• Artifacts Token (must be logged in)

Usage

/**
 * @return CharacterSchema[]
 */
protected function getMyCharacters(): array
{
    try {
        $config = Configuration::getDefaultConfiguration()
            ->setHost(config('artifacts.host'))
            ->setAccessToken(config('artifacts.token'));

        $api = new MyCharactersApi(config: $config);

        return $api->getMyCharactersMyCharactersGet()->getData();
    } catch (\Throwable $e) {
        Log::error('Could not get my characters');

        return [];
    }
}

Using a Service Provider (Laravel)

/**
 * ArtifactsServiceProvider.php
 */
public function register(): void
{
    $this->app->singleton(Configuration::class, function () {
        return Configuration::getDefaultConfiguration()
            ->setHost(config('artifacts.host'))
            ->setAccessToken(config('artifacts.token'));
    });

    $this->app->bind(MyCharactersApi::class, function ($app) {
        return new MyCharactersApi(config: $app->make(Configuration::class));
    });
}

/**
 * Usage
 */
protected function getMyCharacters(): array
{
    try {
        return app(MyCharactersApi::class)
            ->getMyCharactersMyCharactersGet()
            ->getData();
    } catch (\Throwable $e) {
        Log::error('Could not get my characters');

        return [];
    }
}

API Endpoints

Class	Method	HTTP request	Description
AccountsApi	createAccountAccountsCreatePost	POST /accounts/create	Create Account
AccountsApi	forgotPasswordAccountsForgotPasswordPost	POST /accounts/forgot_password	Forgot Password
AccountsApi	getAccountAccountsAccountGet	GET /accounts/{account}	Get Account
AccountsApi	getAccountAchievementsAccountsAccountAchievementsGet	GET /accounts/{account}/achievements	Get Account Achievements
AccountsApi	getAccountCharactersAccountsAccountCharactersGet	GET /accounts/{account}/characters	Get Account Characters
AccountsApi	resetPasswordAccountsResetPasswordPost	POST /accounts/reset_password	Reset Password
AchievementsApi	getAchievementAchievementsCodeGet	GET /achievements/{code}	Get Achievement
AchievementsApi	getAllAchievementsAchievementsGet	GET /achievements	Get All Achievements
BadgesApi	getAllBadgesBadgesGet	GET /badges	Get All Badges
BadgesApi	getBadgeBadgesCodeGet	GET /badges/{code}	Get Badge
CharactersApi	createCharacterCharactersCreatePost	POST /characters/create	Create Character
CharactersApi	deleteCharacterCharactersDeletePost	POST /characters/delete	Delete Character
CharactersApi	getActiveCharactersCharactersActiveGet	GET /characters/active	Get Active Characters
CharactersApi	getCharacterCharactersNameGet	GET /characters/{name}	Get Character
CharactersApi	getCharacterStatsCharactersNameStatsGet	GET /characters/{name}/stats	Get Character Stats
EffectsApi	getAllEffectsEffectsGet	GET /effects	Get All Effects
EffectsApi	getEffectEffectsCodeGet	GET /effects/{code}	Get Effect
EventsApi	getAllActiveEventsEventsActiveGet	GET /events/active	Get All Active Events
EventsApi	getAllEventsEventsGet	GET /events	Get All Events
GameAssistantApi	askGameAssistantGameAssistantAskPost	POST /game_assistant/ask	Ask Game Assistant
GemsShopApi	buyCustomDesignGemsShopBuyCustomDesignPost	POST /gems_shop/buy_custom_design	Buy Custom Design
GemsShopApi	buySkinGemsShopSkinPost	POST /gems_shop/skin	Buy Skin
GemsShopApi	buySpawnEventGemsShopSpawnEventPost	POST /gems_shop/spawn_event	Buy Spawn Event
GemsShopApi	buySubscriptionGemsShopSubscriptionPost	POST /gems_shop/subscription	Buy Subscription
GemsShopApi	getCatalogGemsShopGet	GET /gems_shop/	Get Catalog
GrandExchangeApi	getGeHistoryGrandexchangeHistoryCodeGet	GET /grandexchange/history/{code}	Get Ge History
GrandExchangeApi	getGeOrderGrandexchangeOrdersIdGet	GET /grandexchange/orders/{id}	Get Ge Order
GrandExchangeApi	getGeOrdersGrandexchangeOrdersGet	GET /grandexchange/orders	Get Ge Orders
ItemsApi	getAllItemsItemsGet	GET /items	Get All Items
ItemsApi	getItemItemsCodeGet	GET /items/{code}	Get Item
LeaderboardApi	getAccountsLeaderboardLeaderboardAccountsGet	GET /leaderboard/accounts	Get Accounts Leaderboard
LeaderboardApi	getCharactersLeaderboardLeaderboardCharactersGet	GET /leaderboard/characters	Get Characters Leaderboard
MapsApi	getAllMapsMapsGet	GET /maps	Get All Maps
MapsApi	getLayerMapsMapsLayerGet	GET /maps/{layer}	Get Layer Maps
MapsApi	getMapByIdMapsIdMapIdGet	GET /maps/id/{map_id}	Get Map By Id
MapsApi	getMapByPositionMapsLayerXYGet	GET /maps/{layer}/{x}/{y}	Get Map By Position
MonstersApi	getAllMonstersMonstersGet	GET /monsters	Get All Monsters
MonstersApi	getMonsterMonstersCodeGet	GET /monsters/{code}	Get Monster
MyAccountApi	buyGemsMyBuyGemsPost	POST /my/buy_gems	Buy Gems
MyAccountApi	buySubscriptionMySubscribeStripePost	POST /my/subscribe/stripe	Subscribe with Stripe
MyAccountApi	cancelSubscriptionMySubscribeCancelPost	POST /my/subscribe/cancel	Cancel Subscription
MyAccountApi	changeEmailMyChangeEmailPost	POST /my/change_email	Change Email
MyAccountApi	changePasswordMyChangePasswordPost	POST /my/change_password	Change Password
MyAccountApi	getAccountDetailsMyDetailsGet	GET /my/details	Get Account Details
MyAccountApi	getBankDetailsMyBankGet	GET /my/bank	Get Bank Details
MyAccountApi	getBankItemsMyBankItemsGet	GET /my/bank/items	Get Bank Items
MyAccountApi	getGeHistoryMyGrandexchangeHistoryGet	GET /my/grandexchange/history	Get Ge History
MyAccountApi	getGeOrdersMyGrandexchangeOrdersGet	GET /my/grandexchange/orders	Get Ge Orders
MyAccountApi	getMyGemsHistoryMyGemsHistoryGet	GET /my/gems_history	Get My Gems History
MyAccountApi	getMyPurchaseHistoryMyPurchaseHistoryGet	GET /my/purchase_history	Get My Purchase History
MyAccountApi	getMySubscriptionMySubscriptionGet	GET /my/subscription	Get My Subscription
MyAccountApi	getPendingItemsMyPendingItemsGet	GET /my/pending_items	Get Pending Items
MyAccountApi	getRateLimitsMyRatesGet	GET /my/rates	Get Rate Limits
MyAccountApi	subscribeWithMemberTokenMySubscribeMemberTokenPost	POST /my/subscribe/member_token	Subscribe With Member Token
MyCharactersApi	actionAcceptNewTaskMyNameActionTaskNewPost	POST /my/{name}/action/task/new	Action Accept New Task
MyCharactersApi	actionBuyBankExpansionMyNameActionBankBuyExpansionPost	POST /my/{name}/action/bank/buy_expansion	Action Buy Bank Expansion
MyCharactersApi	actionChangeSkinMyNameActionChangeSkinPost	POST /my/{name}/action/change_skin	Action Change Skin
MyCharactersApi	actionClaimPendingItemMyNameActionClaimItemIdPost	POST /my/{name}/action/claim_item/{id}	Action Claim Pending Item
MyCharactersApi	actionCompleteTaskMyNameActionTaskCompletePost	POST /my/{name}/action/task/complete	Action Complete Task
MyCharactersApi	actionCraftingMyNameActionCraftingPost	POST /my/{name}/action/crafting	Action Crafting
MyCharactersApi	actionDeleteItemMyNameActionDeletePost	POST /my/{name}/action/delete	Action Delete Item
MyCharactersApi	actionDepositBankGoldMyNameActionBankDepositGoldPost	POST /my/{name}/action/bank/deposit/gold	Action Deposit Bank Gold
MyCharactersApi	actionDepositBankItemMyNameActionBankDepositItemPost	POST /my/{name}/action/bank/deposit/item	Action Deposit Bank Item
MyCharactersApi	actionEquipItemMyNameActionEquipPost	POST /my/{name}/action/equip	Action Equip Item
MyCharactersApi	actionFightMyNameActionFightPost	POST /my/{name}/action/fight	Action Fight
MyCharactersApi	actionGatheringMyNameActionGatheringPost	POST /my/{name}/action/gathering	Action Gathering
MyCharactersApi	actionGeBuyItemMyNameActionGrandexchangeBuyPost	POST /my/{name}/action/grandexchange/buy	Action Ge Buy Item
MyCharactersApi	actionGeCancelOrderMyNameActionGrandexchangeCancelPost	POST /my/{name}/action/grandexchange/cancel	Action Ge Cancel Order
MyCharactersApi	actionGeCreateBuyOrderMyNameActionGrandexchangeCreateBuyOrderPost	POST /my/{name}/action/grandexchange/create_buy_order	Action Ge Create Buy Order
MyCharactersApi	actionGeCreateSellOrderMyNameActionGrandexchangeCreateSellOrderPost	POST /my/{name}/action/grandexchange/create_sell_order	Action Ge Create Sell Order
MyCharactersApi	actionGeFillMyNameActionGrandexchangeFillPost	POST /my/{name}/action/grandexchange/fill	Action Ge Fill
MyCharactersApi	actionGiveGoldMyNameActionGiveGoldPost	POST /my/{name}/action/give/gold	Action Give Gold
MyCharactersApi	actionGiveItemsMyNameActionGiveItemPost	POST /my/{name}/action/give/item	Action Give Items
MyCharactersApi	actionMoveMyNameActionMovePost	POST /my/{name}/action/move	Action Move
MyCharactersApi	actionNpcBuyItemMyNameActionNpcBuyPost	POST /my/{name}/action/npc/buy	Action Npc Buy Item
MyCharactersApi	actionNpcSellItemMyNameActionNpcSellPost	POST /my/{name}/action/npc/sell	Action Npc Sell Item
MyCharactersApi	actionRecyclingMyNameActionRecyclingPost	POST /my/{name}/action/recycling	Action Recycling
MyCharactersApi	actionRestMyNameActionRestPost	POST /my/{name}/action/rest	Action Rest
MyCharactersApi	actionTaskCancelMyNameActionTaskCancelPost	POST /my/{name}/action/task/cancel	Action Task Cancel
MyCharactersApi	actionTaskExchangeMyNameActionTaskExchangePost	POST /my/{name}/action/task/exchange	Action Task Exchange
MyCharactersApi	actionTaskTradeMyNameActionTaskTradePost	POST /my/{name}/action/task/trade	Action Task Trade
MyCharactersApi	actionTransitionMyNameActionTransitionPost	POST /my/{name}/action/transition	Action Transition
MyCharactersApi	actionUnequipItemMyNameActionUnequipPost	POST /my/{name}/action/unequip	Action Unequip Item
MyCharactersApi	actionUseItemMyNameActionUsePost	POST /my/{name}/action/use	Action Use Item
MyCharactersApi	actionWithdrawBankGoldMyNameActionBankWithdrawGoldPost	POST /my/{name}/action/bank/withdraw/gold	Action Withdraw Bank Gold
MyCharactersApi	actionWithdrawBankItemMyNameActionBankWithdrawItemPost	POST /my/{name}/action/bank/withdraw/item	Action Withdraw Bank Item
MyCharactersApi	getAllCharactersLogsMyLogsGet	GET /my/logs	Get All Characters Logs
MyCharactersApi	getCharacterLogsMyLogsNameGet	GET /my/logs/{name}	Get Character Logs
MyCharactersApi	getMyCharactersMyCharactersGet	GET /my/characters	Get My Characters
NPCsApi	getAllNpcsItemsNpcsItemsGet	GET /npcs/items	Get All Npcs Items
NPCsApi	getAllNpcsNpcsDetailsGet	GET /npcs/details	Get All Npcs
NPCsApi	getNpcItemsNpcsItemsCodeGet	GET /npcs/items/{code}	Get Npc Items
NPCsApi	getNpcNpcsDetailsCodeGet	GET /npcs/details/{code}	Get Npc
RaidsApi	getAllRaidsRaidsGet	GET /raids	Get All Raids
RaidsApi	getRaidLeaderboardRaidsCodeLeaderboardGet	GET /raids/{code}/leaderboard	Get Raid Leaderboard
RaidsApi	getRaidRaidsCodeGet	GET /raids/{code}	Get Raid
ResourcesApi	getAllResourcesResourcesGet	GET /resources	Get All Resources
ResourcesApi	getResourceResourcesCodeGet	GET /resources/{code}	Get Resource
SeasonRewardsApi	getAllSeasonRewardsSeasonRewardsGet	GET /season_rewards	Get All Season Rewards
SeasonRewardsApi	getSeasonRewardsByCodeSeasonRewardsCodeGet	GET /season_rewards/{code}	Get Season Rewards By Code
ServerDetailsApi	getServerDetailsGet	GET /	Get Server Details
SimulationApi	fightSimulationSimulationFightPost	POST /simulation/fight	Fight Simulation
SkinsApi	getAllSkinsSkinsGet	GET /skins	Get All Skins
SkinsApi	getSkinSkinsCodeGet	GET /skins/{code}	Get Skin
TasksApi	getAllTasksRewardsTasksRewardsGet	GET /tasks/rewards	Get All Tasks Rewards
TasksApi	getAllTasksTasksListGet	GET /tasks/list	Get All Tasks
TasksApi	getTaskTasksListCodeGet	GET /tasks/list/{code}	Get Task
TasksApi	getTasksRewardTasksRewardsCodeGet	GET /tasks/rewards/{code}	Get Tasks Reward
TokenApi	generateTokenTokenPost	POST /token	Generate Token

Models

• AccessSchema
• AccountAchievementObjectiveSchema
• AccountAchievementSchema
• AccountDetails
• AccountDetailsSchema
• AccountLeaderboardSchema
• AccountLeaderboardType
• AccountStatus
• AchievementObjectiveSchema
• AchievementResponseSchema
• AchievementRewardsSchema
• AchievementSchema
• AchievementType
• ActionType
• ActiveCharacterSchema
• ActiveEventResponseSchema
• ActiveEventSchema
• AddAccountSchema
• AddCharacterSchema
• AssistantAnswerDataSchema
• AssistantAnswerSchema
• AssistantQuestionSchema
• BadgeResponseSchema
• BadgeSchema
• BankExtensionSchema
• BankExtensionTransactionResponseSchema
• BankExtensionTransactionSchema
• BankGoldTransactionResponseSchema
• BankGoldTransactionSchema
• BankItemTransactionResponseSchema
• BankItemTransactionSchema
• BankResponseSchema
• BankSchema
• BuyCustomDesignRequestSchema
• BuySkinRequestSchema
• BuySkinResponseDataSchema
• BuySkinResponseSchema
• ChangeEmailSchema
• ChangePasswordSchema
• ChangeSkinCharacterDataSchema
• ChangeSkinCharacterSchema
• ChangeSkinResponseSchema
• CharacterFightDataSchema
• CharacterFightResponseSchema
• CharacterFightSchema
• CharacterLeaderboardSchema
• CharacterLeaderboardType
• CharacterMovementDataSchema
• CharacterMovementResponseSchema
• CharacterMultiFightResultSchema
• CharacterResponseSchema
• CharacterRestDataSchema
• CharacterRestResponseSchema
• CharacterSchema
• CharacterStatsResponseSchema
• CharacterStatsSchema
• CharacterTransitionDataSchema
• CharacterTransitionResponseSchema
• CharactersListSchema
• CheckoutResponseSchema
• CheckoutResponseWrapperSchema
• ClaimPendingItemDataSchema
• ClaimPendingItemResponseSchema
• CombatResultSchema
• CombatSimulationDataSchema
• CombatSimulationRequestSchema
• CombatSimulationResponseSchema
• ConditionOperator
• ConditionSchema
• CooldownSchema
• CraftSchema
• CraftSkill
• CraftingSchema
• DataPageAccountAchievementSchema
• DataPageAccountLeaderboardSchema
• DataPageActiveCharacterSchema
• DataPageCharacterLeaderboardSchema
• DataPageGEOrderHistorySchema
• DataPageGEOrderSchema
• DataPageLogSchema
• DataPagePendingItemSchema
• DataPageRaidLeaderboardEntrySchema
• DataPageSimpleItemSchema
• DeleteCharacterSchema
• DeleteItemResponseSchema
• DeleteItemSchema
• DepositWithdrawGoldSchema
• DestinationSchema
• DropRateSchema
• DropSchema
• EffectResponseSchema
• EffectSchema
• EffectSubtype
• EffectType
• EquipSchema
• EquipmentItemSchema
• EquipmentResponseSchema
• EquipmentTransactionSchema
• ErrorResponseSchema
• ErrorSchema
• EventContentSchema
• EventMapSchema
• EventSchema
• FakeCharacterSchema
• FightRequestSchema
• FightResult
• GEBuyOrderCreationSchema
• GEBuyOrderSchema
• GECancelOrderSchema
• GECreateOrderTransactionResponseSchema
• GEFillBuyOrderSchema
• GEOrderCreatedSchema
• GEOrderCreationSchema
• GEOrderHistorySchema
• GEOrderResponseSchema
• GEOrderSchema
• GEOrderTransactionSchema
• GEOrderType
• GETransactionListSchema
• GETransactionResponseSchema
• GETransactionSchema
• GatheringSkill
• GemShopCatalogDataSchema
• GemShopCatalogResponseSchema
• GemShopCustomDesignCatalogItemSchema
• GemShopCustomDesignPurchaseResponseDataSchema
• GemShopCustomDesignPurchaseResponseSchema
• GemShopSkinCatalogItemSchema
• GemShopSpawnEventCatalogItemSchema
• GemShopSubscriptionCatalogItemSchema
• GemShopSubscriptionResponseDataSchema
• GemShopSubscriptionResponseSchema
• GemTransactionListResponseSchema
• GemTransactionSchema
• GiveGoldDataSchema
• GiveGoldResponseSchema
• GiveGoldSchema
• GiveItemDataSchema
• GiveItemResponseSchema
• GiveItemsSchema
• GoldSchema
• HTTPValidationError
• InteractionSchema
• InventorySlotSchema
• ItemResponseSchema
• ItemSchema
• ItemSlot
• ItemType
• LocationInner
• LogSchema
• LogType
• MapAccessType
• MapContentSchema
• MapContentType
• MapLayer
• MapResponseSchema
• MapSchema
• MemberTokenSubscriptionResponseDataSchema
• MemberTokenSubscriptionResponseSchema
• MonsterResponseSchema
• MonsterSchema
• MonsterType
• MyAccountDetails
• MyAccountDetailsSchema
• MyCharactersListSchema
• NPCItemSchema
• NPCResponseSchema
• NPCSchema
• NPCType
• NpcItemTransactionSchema
• NpcMerchantBuySchema
• NpcMerchantTransactionResponseSchema
• NpcMerchantTransactionSchema
• PasswordResetConfirmSchema
• PasswordResetRequestSchema
• PasswordResetResponseSchema
• PendingItemSchema
• PendingItemSource
• PurchaseGemsRequestSchema
• PurchaseHistoryListResponseSchema
• PurchaseHistorySchema
• PurchaseType
• RaidDamageRewardSchema
• RaidInstanceResult
• RaidInstanceSchema
• RaidLeaderboardEntrySchema
• RaidRankRewardSchema
• RaidResponseSchema
• RaidRewardsSchema
• RaidScheduleSchema
• RaidSchema
• RaidStatus
• RaidWeekday
• RateLimitSchema
• RateLimitScopeSchema
• RateLimitWindowSchema
• RateLimitsDataSchema
• RateLimitsSchema
• RecyclingDataSchema
• RecyclingItemsSchema
• RecyclingResponseSchema
• RecyclingSchema
• ResourceResponseSchema
• ResourceSchema
• ResponseSchema
• RewardDataResponseSchema
• RewardDataSchema
• RewardItemSchema
• RewardResponseSchema
• RewardType
• RewardsSchema
• SeasonRewardSchema
• SeasonSchema
• SimpleEffectSchema
• SimpleItemSchema
• SimpleNPCItemSchema
• Skill
• SkillDataSchema
• SkillInfoSchema
• SkillResponseSchema
• SkinResponseSchema
• SkinSchema
• SpawnEventRequestSchema
• StaticDataPageAchievementSchema
• StaticDataPageActiveEventSchema
• StaticDataPageBadgeSchema
• StaticDataPageDropRateSchema
• StaticDataPageEffectSchema
• StaticDataPageEventSchema
• StaticDataPageItemSchema
• StaticDataPageMapSchema
• StaticDataPageMonsterSchema
• StaticDataPageNPCItemSchema
• StaticDataPageNPCSchema
• StaticDataPageRaidSchema
• StaticDataPageResourceSchema
• StaticDataPageSeasonRewardSchema
• StaticDataPageSkinSchema
• StaticDataPageTaskFullSchema
• StatusResponseSchema
• StatusSchema
• StatusSeasonRewardSchema
• StorageEffectSchema
• StripeSubscriptionPlan
• SubscribeRequestSchema
• SubscriptionPlan
• SubscriptionResponseSchema
• SubscriptionSchema
• TaskCancelledResponseSchema
• TaskCancelledSchema
• TaskDataSchema
• TaskFullResponseSchema
• TaskFullSchema
• TaskResponseSchema
• TaskSchema
• TaskTradeDataSchema
• TaskTradeResponseSchema
• TaskTradeSchema
• TaskType
• TokenResponseSchema
• TransitionSchema
• UnequipSchema
• UseItemResponseSchema
• UseItemSchema
• ValidationError

Author

The Artifacts MMO game: https://docs.artifactsmmo.com/funding

Author of this package: @ryanbeiden

SDK Generated using: OpenAPITools/openapi-generator

About this package

API method for this PHP package are automatically generated by the OpenAPI Generator project:

• API version: 7.0.4
  • Package version: 1.0.0
  • Generator version: 7.23.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen