Create an Advertiser API
If you have your own system and would like to create advertiser accounts without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.
- Parameters (Bold are mandatory) if the optional parameters not supplied then there is no value set to these fields
Parameter Name (Case Sensitive) |
Value |
Description |
Default Value |
user (mandatory) |
Admin’s username |
The admin’s username that matches the api_id |
|
api_id (mandatory) |
Admin’s Api Id |
The admin’s api_id that matches the username |
Generated from edit profile |
fname (mandatory) |
Advertiser’s First Name |
Advertiser’s First Name |
|
lname (mandatory) |
Advertiser’s Last Name |
Advertiser’s Last Name |
|
email (mandatory) |
Advertiser’s email |
Advertiser’s email |
|
company (mandatory)
|
Advertiser’s company name |
Advertiser’s company name |
|
phone (mandatory) |
Advertiser’s local phone |
Advertiser’s local phone |
|
user_name |
User Name |
The advertiser's user name (if not supplied then the email will be the user name) |
Email parameter |
promotion |
Reseller’s / Sale’s promotion code |
Set the new advertiser under the reseller / sales agent |
No reseller, No Sales agent |
package |
Package ID |
Set this package to this new advertiser |
Level 1 package |
group |
Group ID |
Set this group to this new advertiser |
No Group |
activated
|
true / false |
If true, will activate the account of this new advertiser |
false |
send_email
|
true / false |
If false, will not send a welcome email with user name and password to the new advertiser |
true |
password |
Advertiser password |
* Minimum 6 Characters * Password must contains one letter and one number * Password cannot contain the following characters: #, %, &, + |
Password is generated automatically |
pre_paid |
true / false |
If true indicates that this is a pre paid account |
false |
auto_charge |
true / false |
If true indicates that this account will be billed automatically on his bills in case it have a credit card data at his account |
false |
agree_notifications |
true / false |
If true then set the agree to get notification by mail to true (If supplied, you must ask the user to agree to that at your side) |
|
agree_terms |
true / false |
If true then set the agree to terms and conditions to true (If supplied, you must ask the user to agree to that at your side) |
|
isCreateApiKey |
true / false |
Indicate if need to create API Key to this new advertiser |
false |
Return Code
- If the API succeeds, then it will return with status code 200 with the following message: “User created successfully"
- If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Example:
https://mcpn.us/api?ev=createAdv&user=adminuser&api_id=A1H444h07FhB65dn&fname=Jhon&lname=Smith&email=jsmith@gmail.com&company=mycomany&phone=17225555555
Comments
0 comments
Article is closed for comments.