Give your application access to the infrastructure around your product — configuration, licensing, notifications, support and policies.
// Your application App Key app_xxxxxxxxxxxxxxxxx App Secret •••••••••••••••••••• Timestamp 1770000000 // Signed request POST /api/v1/license/verify X-App-Key: app_xxxxxxxxx X-Timestamp: 1770000000 X-Signature: hmac_sha256(...) // AppForge → authenticated → request processed → JSON response
Getting started
The API is application-based. First create your application in AppForge, then use that application's credentials when communicating with its infrastructure.
Register your application from the AppForge admin panel.
Use the App Key and App Secret belonging to that application.
Generate a timestamp and HMAC-SHA256 signature for authenticated requests.
Use the modules your application needs.
Authentication
Authenticated application APIs use your application's App Key, timestamp and HMAC-SHA256 signature.
App Key
Identifies the application making the request.
Timestamp
Current Unix timestamp used as part of the signed request.
Signature
HMAC-SHA256 signature generated using the App Secret.
// Build the canonical request canonical = METHOD + "\n" + PATH + "\n" + TIMESTAMP + "\n" + BODY // Generate signature signature = HMAC-SHA256( canonical, APP_SECRET ) // Send authentication headers X-App-Key: APP_KEY X-Timestamp: TIMESTAMP X-Signature: SIGNATURE
Keep your App Secret private.
Your App Secret is used to generate request signatures. Do not expose it in browser-side JavaScript or public repositories.
Request flow
Build the signing logic once and use it across the authenticated AppForge modules.
01
Choose endpoint
02
Build request
03
Sign request
04
Send request
05
Receive JSON
API modules
AppForge provides separate API capabilities for configuration, licensing, Firebase devices, support and public policies.
Configuration
Retrieve all application settings or retrieve a specific setting by key.
Licensing
Activate, verify and deactivate software licenses.
Notifications
Register devices, unregister them and maintain their application heartbeat.
Customer support
Create tickets, list customer tickets, view conversations and send replies.
Public content
Retrieve application policies using a public application key.
Designed around your app
Your application can use only the AppForge services it actually needs.
Retrieve all settings or fetch a single value using its key. The settings belong to the application whose credentials authenticate the request.
// All settings GET /api/v1/settings // Single setting GET /api/v1/settings/{key} // Example GET /api/v1/settings/app_name
// Activate POST /api/v1/license/activate { "license_key": "LIC-XXXX-XXXX", "identifier": "example.com", "app_version": "1.0.0" } // Verify POST /api/v1/license/verify // Deactivate POST /api/v1/license/deactivate
Your application can activate a license against an identifier, verify its status and deactivate it when required.
Activate
Bind license
Verify
Check status
Deactivate
Release activation
Register FCM devices against a license, update device information, unregister devices and send heartbeat information from your application.
POST /api/v1/fcm/register
Register or update an FCM device.
POST /api/v1/fcm/unregister
Remove an FCM device.
POST /api/v1/fcm/heartbeat
Send an application heartbeat.
Device registration
{
"license_key":
"LIC-XXXX-XXXX",
"fcm_token":
"DEVICE_TOKEN",
"platform":
"android",
"device_identifier":
"device-001",
"device_name":
"My Android",
"app_version":
"1.0.0"
}
// Create POST /api/v1/support/tickets // List GET /api/v1/support/tickets // View GET /api/v1/support/tickets/{ticketNumber} // Reply POST /api/v1/support/tickets/{ticketNumber}/messages
Let customers create and manage support conversations directly from your software while your team manages the same tickets from the AppForge admin panel.
Create tickets
Subject, message and priority.
List tickets
Show customer conversations.
View tickets
Retrieve a conversation.
Reply
Continue the conversation.
Policy requests are public and use the application's public key. They do not require an API secret, HMAC signature or license key.
// Public request GET /api/public/v1/policies/ {publicKey}/ {type} // Examples GET /api/public/v1/policies/ app_xxxxx/privacy GET /api/public/v1/policies/ app_xxxxx/terms
Integration example
Your application creates the canonical request, signs it with its App Secret and sends the authentication headers with the request.
// Example: Verify a license $method = 'POST'; $path = '/api/v1/license/verify'; $timestamp = time(); $body = json_encode([ 'license_key' => 'LIC-XXXX-XXXX' ]); // Build the canonical request $canonical = $method . "\n" . $path . "\n" . $timestamp . "\n" . $body; // Generate HMAC-SHA256 signature $signature = hash_hmac( 'sha256', $canonical, $appSecret ); // Send: X-App-Key: $appKey X-Timestamp: $timestamp X-Signature: $signature
Keep credentials server-side
The App Secret should remain private. If an integration runs entirely in a browser or other public client, use only the public capabilities intended for that environment and do not expose private application credentials.
At a glance
Create an AppForge application, get your credentials and connect the infrastructure your software needs.