API Getting Started
For security purposes the API is disabled by default and must be enabled before you can start issuing commands.
Open the API configuration (located at Server/appsettings.Production.json)
Set the Api.Enabled field to true as shown below:
Optionally change the Hosts field to listen on your desired network ports.
Before you can authenticate with the API you must have created a user account within the game.
After creating an account open the server console and issue the following command:
api [name] trueThat command will grant the specified account access to authtenticate with the API.
You are now ready to request an authentication token from our API, click here to learn how.
- Home
- Authors
- Introduction
- Licensing and Cost
- Code of Conduct
- Contributing
- Prerequisites
- Requirements
- Improvement and fixing
- Supported Platforms
- Quick FAQ
- Published Games
-
Downloading Intersect
- File Structure
- Setup
- Compiling
- 📌 List of add-ons & guides
- 🛠️ List of tools
- 🎞️ List of videos
- Overview
- Setup Server
- Port Forwarding
- Config file (config.json)
- Server Console Commands
- Database
- Creating New Packets
- Security
- Passwords
- Web server & CMS
- Overview
- Editor Login
- Editor & Client config file
- Editor functionality
- Animations
- Classes
- Conditions
- Items
- Mapping
- Npcs
- Projectiles
- Quests
- Resources
- Shops
- Spells
- Variables
- Time (Day & Night)
- World / Map Design
- Z-Dimensions
- Map & Tile Sizes
- Introduction
- Common Events
- Event Commands
- Chat Commands
- Examples & Guides
- Intersect Event System Tutorial
- Introduction
- Getting Started
- Configuration
- Roles
- Endpoints
- Authentication
- Server Info
- Users
- Players
- Variables
- Chat
- Logs
- Admin Actions
- Game Objects
- 🔗Hash Generators
- Overview