Admin Area Backend - Documentation
Setup guide and full API reference for the Admin Area Backend app.
In all URLs below, replace XXX with your AI Apps Account ID, found in your account settings.
Setting Up Your Admin Area
How to create a platform and configure admin pages
The Admin Area Backend lets you create a private, password-protected admin panel for your users. Your users get their own accounts with login, registration, profile management, and custom data pages that you design. Each admin area is called a platform, and you can run multiple platforms from one account.
Step 1: Enable the AppGo to your dashboard and enable the Admin Area Backend app. This creates your platform management area.
Step 2: Create a Platform
Go to Manage Platforms and create a new platform. Give it a name that identifies the project or business it belongs to. Each platform keeps its users and data completely separate from other platforms.
The platform has one setting: Allow Webhook. Turn this on if you want external systems (video games, mobile apps, other websites) to manage user accounts through the API. Leave it off if your users will only log in through a website.
Step 3: Create Admin Pages
From the main Admin Area Backend screen, click your platform name. This is where you create the data pages your users will see. Click Create New Page and give it a name. Each page manages one type of data, for example "Projects" or "Orders" or "Notes".
After creating a page, click it to configure the fields your users will fill out. Each page starts with a single Name field, and you can edit the page definition to add more fields, change field types, and control what users can create, edit, or delete.
Tip: You can also use the AI-powered admin builder to design your pages through a conversation instead of editing the fields manually.
Connecting to a Website
Optional: host your admin area on your own domain
If you want your users to log in through a website, connect your platform to a domain in the Website Builder. This is optional. You can also use the webhook API to manage users without a website.
Step 1: Create your platform firstThe platform must exist in the Admin Area Backend before it will appear as an option in the Website Builder. If you have not created a platform yet, go back to the Admin Area Backend and create one.
Step 2: Assign the platform in Website Builder
Open your domain in the Website Builder and go to App Settings. You will see an Admin Area dropdown menu. Select your platform from the list. This connects the platform to that domain.
Once connected, every page on that domain will require login. Visitors who are not logged in will see a login and registration form. After logging in, your users will see the website pages you built plus an automatically generated navigation menu with all the admin pages you created for that platform, along with an Account Settings page where they can update their profile and change their password.
Note: The admin area dropdown only shows platforms you have already created. If the dropdown is empty, go to the Admin Area Backend and create a platform first.
How Endpoints Work
Two ways to call each endpoint, read this first
App Command (API Call)
POST your request to
Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required, the account ID is part of the URL.
POST your request to
https://api.aiappsapi.com with your API key and account ID in the POST body. The fields described in each section below go inside the jsonData POST field as a JSON-encoded string. Use this method when your server is making the call and you have your API credentials available.Mode / Webhook (Direct URL)
POST directly to the endpoint URL shown in each section. The fields go in the POST body as standard form fields (the same fields you would include in an HTML form POST). Use this method for provider webhooks, website forms, or any third-party system that sends form data. No API key is required, the account ID is part of the URL.
All webhook actions require either a
platformID or a domain field. If you pass a domain name, the system looks up which platform is assigned to that domain. If you pass a platformID directly, no domain is needed. You can also pass both, in which case the platformID you send is used and the domain is verified for session security.
Webhook URL
Single endpoint for all account management actions
All webhook actions use the same URL. The
action field determines what happens. The webhook must be enabled on the platform by turning on Allow Webhook in the platform settings.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required For All Actions
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | The action to perform. Valid values: login, create, getinfo, updateinfo, deleteaccount, logout, forgotpass, forgotpasscode |
Identifying The Platform (at least one required)
| Field Name | Field Key | Notes |
|---|---|---|
| Platform ID | platformID | The numeric ID of the platform. Found in the Admin Area Backend under Manage Platforms. |
| Domain | domain | A domain name that has this platform assigned in the Website Builder. The system will look up the platform ID from the domain. Also verifies you own the domain. |
Create Account
action: create
Creates a new user account on the platform. The email address must be unique within the platform. A session is started automatically after the account is created.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | create |
| The user's email address. Must be unique on this platform. | ||
| Password | pass | Must be at least 7 characters. |
Optional Fields
| Field Name | Field Key | Notes |
|---|---|---|
| First Name | fname | User's first name. |
| Last Name | lname | User's last name. |
| Phone | phone | User's phone number. |
Login
action: login
Logs a user into their account. Returns the user's profile information and a session ID. The session ID can be used to maintain the login state across requests.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | login |
| The user's email address. | ||
| Password | pass | The user's password. |
Get Account Info
action: getinfo
Returns the logged-in user's profile information. Requires an active session from a previous login or account creation.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | getinfo |
Requires an active session. The user must have logged in or created an account first.
Update Account Info
action: updateinfo
Updates the logged-in user's profile information. Only the fields you include will be changed. Requires an active session.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | updateinfo |
Optional Fields
| Field Name | Field Key | Notes |
|---|---|---|
| First Name | fname | New first name. |
| Last Name | lname | New last name. |
| Phone | phone | New phone number. |
| Password | pass | New password. Must be at least 7 characters. |
Requires an active session. The user must have logged in or created an account first.
Logout
action: logout
Ends the user's session. After logging out, any actions that require a session will return an error until the user logs in again.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | logout |
Delete Account
action: deleteaccount
Permanently deletes the logged-in user's account and all associated data. The session is cleared after deletion. This cannot be undone.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | deleteaccount |
Requires an active session. The user must have logged in first.
Forgot Password
action: forgotpass
Starts the password reset process. Generates a one-time reset code that expires after 48 hours. The reset code will be sent to the user's email address. Use the
forgotpasscode action to complete the reset with the code.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | forgotpass |
| The email address of the account to reset. |
Does not require an active session. The reset code is sent to the user's email address.
Reset Password With Code
action: forgotpasscode
Completes the password reset process. The user provides the reset code they received by email along with their new password. The code can only be used once.
POST Webhook URL
https://api.aiappsapi.com/XXX/accountadmin/webhook
Required Fields
| Field Name | Field Key | Notes |
|---|---|---|
| Action | action | forgotpasscode |
| The email address of the account. | ||
| Reset Code | code | The one-time reset code from the email. |
| New Password | newpass | The new password. Must be at least 7 characters. |
Does not require an active session. The reset code expires after 48 hours.