URL
http://[platform_URL]/api/manager/get-affiliate-info/[Affiliate_ID]
Input Parameters
| Field Name | Required | Description |
|---|---|---|
| api-key | Yes | Ask your Admin for API activation. API Key could be found on your Profile page. |
Output Parameters
| Field Name | Description |
|---|---|
| id | Affiliate ID |
| login | Affiliate login email |
| account | Affiliate balance value |
| name | Company name |
| status | Affiliate Status (1=Active, 2=Pending, 3=Rejected) |
| fname | First Name |
| lname | Last Name |
| phone | Phone number |
| Affiliate email (the same as login) | |
| country_id | The Country ID |
| region | Region |
| address | Address |
| city | City |
| postal | Postal Code |
| im | Messenger login |
| im_type | The type of messenger (1=AIM, 2=MSN, 3=YAHOO, 4=ICQ, 5=SKYPE) |
| payment_terms | Payment terms (1=NET 0, 2=NET 7, 3=NET 14, 4=NET 30, 5=NET 60) |
| payment_type | Payment method (1=Bank Wire, 2=WebMoney, 3=PayPal) |
| payment_details | Details (Account number, WebMoney wallet, ID etc.) |
| notifications | Send email notifications (0=Do not send, 1=Send) |
| affiliate_type | Affiliate Type (1=Basic, 2=Premium) |
| ref_id | Referral Sponsor ID |
| ref_share | Referrals Commission |
| ref_bonus | Affiliate's Referral balance value |
| image | Image name |
| ip | User IP |
| last_payment | The date of last received payout (yyyy-mm-dd hh:mm:ss) |
| last_seen | The date of last login (yyyy-mm-dd hh:mm:ss) |
| added | The date of profile creation (yyyy-mm-dd hh:mm:ss) |
| access_token | The value of the Affiliate API token (if enabled) |
| api_enabled | API (1=enabled, 2=disabled) |
| unsubscribe_token | The value of unsubscribe token (for email unsubscribe) |
| subscription_status | The status of email subscription (1=Active, 2=inactive) |
| Custom fields section | |
| type | Custom field's type (1=Short text, 2=long text, 3=Yes/No checkbox) |
| field | The custom field's variable name |
| title | The custom field's title |
| description | The custom field's description |
| value | The custom field's value - user's input. For type "3": 1=Yes, 2=No |
Sample Request
http://demo.scaleo-up.com/api/manager/get-affiliate-info/13?api-key=9eb500a476603546a779e6418117ef0403aa3f64
Response
{
"code": 0,
"status": 200,
"affiliateInfo": [
{
"id": 13,
"login": "basic@t.com",
"account": 211.82,
"complete_date_balance": 0,
"complete_date_ref_balance": 0,
"name": "BASIC",
"status": 1,
"fname": "Basic",
"lname": "Aff",
"phone": "11111113333",
"email": "basic@t.com",
"country_id": 39,
"region": "Quebec",
"address": "123 street",
"city": "Bullroom",
"postal": "1234567",
"im": "basic",
"im_type": 5,
"payment_terms": 1,
"payment_type": 2,
"payment_details": "Some details here",
"notifications": 0,
"affiliate_type": 1,
"ref_id": 8,
"ref_bonus": 1,
"ref_account": 1.51,
"image": "5a674b610abd8.png",
"ip": "",
"last_payment": null,
"last_seen": "2018-02-05 18:31:21",
"added": "2018-01-23 17:49:04",
"access_token": "f8e12478527eb6c1a541b516d419f7b4f53e59e3",
"api_enabled": 2,
"unsubscribe_token": "a0ae15571eb4a97ac1c34a114f1bb179",
"subscription_status": 1,
"custom_fields": [
{
"type": "1",
"field": "custom_1",
"title": "Your nick name",
"description": "",
"value": "Ivan"
},
{
"type": "3",
"field": "custom_2",
"title": "Do you have a pet?",
"description": "We like pets",
"value": "2"
},
{
"type": "2",
"field": "custom_3",
"title": "Short story about your life",
"description": "",
"value": "Boring things"
}
],
}
]
}