AyakaMods Developer API
Integrate AyakaMods mods into a mod manager / launcher (browse across games, Vortex-style) or into an official game client (scoped to just your game).
Everything documented here is implemented and testable on our local dev instance. The public host (ayakamods.com) is not live for this yet. Base URLs, issued keys, and any final field naming are placeholders until go-live.
What this is
AyakaMods runs on XenForo. Its REST API is XenForo's native API with an AyakaMods scoping layer on top. You authenticate with a single API key and get back JSON. There is no SDK to install and nothing engine-specific - plain HTTPS + JSON, called from whatever your app or engine uses for HTTP.
Two access tiers
AyakaMods issues two kinds of key. Which one you get depends on who you are.
| Tier | Who | Sees | How issued |
|---|---|---|---|
| Mod manager / launcher | Third-party tools (Vortex-style) | All public games | Request access, staff issues a key |
| Official game developer | A game's own developer/team | Only that game's mods | Register your game, staff approves |
Unlike NexusMods and GameBanana - which only serve third-party tools - AyakaMods also courts official game developers directly, the way AyakaMods does. Pick the guide that matches you:
Next
- Getting Started - base URL, first call
- Authentication - how the key works
- Endpoints - the full reference