Skip to main content

API

Endpoints

The following API endpoints to the dashboard are available on the dash.iapguard.com domain:

MethodBase URLRequest Type
Add App/api/apps/addPOST
caution

API requests to the dashboard are rate-limited as a security measure. If your request was throttled (HTTP status 429), please try again a minute later.

Authentication

The HEADER of your request should contain the following fields and values:

FieldDescription
X-Auth-EmailThe email you registered your account with.
X-Auth-KeyThe API Key found in your Profile tab at the top.

Add App

Call this function in order to automate the app creation process on our platform. More details on the field values can be found in the App Setup documentation.

Please note that the subscription plan cannot be passed in, as it requires manual confirmation. Apps added via the API will start on the FREE plan automatically.

Request

JSON encoded values in request body.

FieldDescription
nameRequired. The name of your new app.
user_modeUser Behaviour value as number:
Disabled = 0
Transfer = 1
Block = 2
Alias = 3
bid_google
bid_apple
The corresponding Bundle IDs.
key_google
key_apple
key_paypal
License Keys in a JSON-compatible format, meaning all spaces, line breaks or \n should be replaced with \\n. For example, if you are using a string escaper tool, you would have to pass in your original Google key once and the original Apple key twice. On PayPal, concatenate Sandbox and Production values using a semicolon.
acc_google
acc_apple
acc_paypal
Account IDs. Since the Apple ID consists of two values, concatenate them using a semicolon. On PayPal, concatenate Sandbox and Production values using a semicolon.
`web_paypal``Webhook IDs. Concatenate Sandbox and Production values using a semicolon.

Response

JSON encoded values in response body.

Success: HTTP Status 200.
Failed: HTTP Status 400, 405, 429.

FieldDescription
successtrue or false.
idThe app ID created.
errorDescription of the error in case success = false.

Example

Request

{
"name":"Your new App name",
"user_mode":0,
"bid_google":"yourAndroidBundleID",
"bid_apple":"yourAppleBundleID",
"key_google":"-----BEGIN PRIVATE KEY-----\\n.....\\n-----END PRIVATE KEY-----\\n",
"key_apple":"-----BEGIN PRIVATE KEY-----\\.....\\n-----END PRIVATE KEY-----",
"key_paypal":"yourSandboxSecret;yourProductionSecret",
"acc_google":".....gserviceaccount.com",
"acc_apple":"yourIssuerKey;yourKIDKey",
"acc_paypal":"yourSandboxClientID;yourProductionClientID",
"web_paypal":"yourSandboxWebhookID;yourProductionWebhookID"
}

Response

{
"success":true,
"id":"abcdefghijklm123"
}