Difference between revisions of "NATS For Networks REST Add Affiliate"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS For Networks Manual | show_api_admin_section = true }} == '''POST /offer/add_affiliate''' == '''Description''' *add_affiliate adds a new affiliate '''Resource URL''...") |
|||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{NATS | + | {{NATS for Networks Manual |
| − | | | + | | show_rest_api_section = true |
}} | }} | ||
| − | == '''POST / | + | == '''POST /affiliate/add_affiliate''' == |
'''Description''' | '''Description''' | ||
*add_affiliate adds a new affiliate | *add_affiliate adds a new affiliate | ||
| Line 8: | Line 8: | ||
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api/ | + | *<nowiki>http://domain/api/affiliate/add_affiliate</nowiki> |
*Replace domain with the NATS For Networks domain | *Replace domain with the NATS For Networks domain | ||
| Line 37: | Line 37: | ||
**'''''required''''' | **'''''required''''' | ||
**Payvia type id of the payvia type to use with this affiliate | **Payvia type id of the payvia type to use with this affiliate | ||
| + | *payvia_info | ||
| + | **'''''type: array''''' | ||
| + | **'''''an array containing field/value pair arrays of payvia information to set for the affiliate''''' | ||
| + | **'''''Must send "payvia" parameter to indicate which payvia type payvia_info is for.''''' | ||
*email | *email | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| Line 57: | Line 61: | ||
**'''''type: string''''' | **'''''type: string''''' | ||
*msn | *msn | ||
| + | **'''''type: string''''' | ||
| + | *skype | ||
**'''''type: string''''' | **'''''type: string''''' | ||
*address1 | *address1 | ||
| Line 80: | Line 86: | ||
*join_ip | *join_ip | ||
**'''''type: string''''' | **'''''type: string''''' | ||
| + | *custom1 | ||
| + | **'''''type: string''''' | ||
| + | **'''''max 255 characters''' | ||
| + | *custom2 | ||
| + | **'''''type: string''''' | ||
| + | **'''''max 255 characters''' | ||
| + | *custom3 | ||
| + | **'''''type: string''''' | ||
| + | **'''''max 255 characters''' | ||
| + | *custom4 | ||
| + | **'''''type: string''''' | ||
| + | **'''''max 255 characters''' | ||
| + | *custom5 | ||
| + | **'''''type: string''''' | ||
| + | **'''''max 255 characters''' | ||
| + | *status | ||
| + | **'''''type: int''''' | ||
| + | **'''''Possible values: 0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied''' | ||
== '''Example Request''' == | == '''Example Request''' == | ||
| Line 91: | Line 115: | ||
firstname = hello | firstname = hello | ||
lastname = test | lastname = test | ||
| − | email = hello@ | + | email = hello@n4n.com |
| − | company = | + | company = N4N |
| − | url = | + | url = natsfornetworks.com |
tel = 666-666-6666 | tel = 666-666-6666 | ||
icq = 666666666 | icq = 666666666 | ||
| Line 157: | Line 181: | ||
'ref' => 'asdasd', | 'ref' => 'asdasd', | ||
'join_ip' => '192.168.1.1', | 'join_ip' => '192.168.1.1', | ||
| − | 'payvia' => 1, | + | 'payvia' => '1', // Check payvia type |
| + | // notice the structure is an array of sub-arrays that have field/value pairs | ||
| + | 'payvia_info' => Array( | ||
| + | Array( | ||
| + | 'field' => 'Pay To', | ||
| + | 'value' => 'Affiliate PayTo Name', | ||
| + | ), | ||
| + | Array( | ||
| + | 'field' => 'Address', | ||
| + | 'value' => 'Affiliate Address', | ||
| + | ), | ||
| + | ), | ||
); | ); | ||
$resp = curl_exec($curl); | $resp = curl_exec($curl); | ||
| − | //dumps an associative array representation of the json | + | //dumps an associative array representation of the json response |
| − | + | $output = json_decode($resp, true); | |
| + | if($output !== NULL) { | ||
| + | //json was valid. Dump the decoded array | ||
| + | print_r($output); | ||
| + | } | ||
| + | else { | ||
| + | //invalid json, just dump the raw response | ||
| + | print_r($resp); | ||
| + | } | ||
// Close request to clear up some resources | // Close request to clear up some resources | ||
curl_close($curl); | curl_close($curl); | ||
Latest revision as of 13:52, 13 September 2022
POST /affiliate/add_affiliate
Description
- add_affiliate adds a new affiliate
Resource URL
- http://domain/api/affiliate/add_affiliate
- Replace domain with the NATS For Networks domain
Response Format
- JSON
- POST
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- username
- type: string
- required
- unique
- Affiliate username
- password
- type: string
- required
- Affiliate Password
- payvia
- type: int
- required
- Payvia type id of the payvia type to use with this affiliate
- payvia_info
- type: array
- an array containing field/value pair arrays of payvia information to set for the affiliate
- Must send "payvia" parameter to indicate which payvia type payvia_info is for.
- email
- type: string
- required
- unique
- Email address for this affiliate
- firstname
- type: string
- lastname
- type: string
- company
- type: string
- url
- type: string
- tel
- type: string
- icq
- type: string
- aim
- type: string
- msn
- type: string
- skype
- type: string
- address1
- type: string
- address2
- type: string
- city
- type: string
- state
- type: string
- country
- type: string
- zip_code
- type: string
- tax_id_or_ssn
- type: string
- ref
- type: string
- Tracking code to identifier who referred this affiliate.
- minimum_payout
- type: string
- Threshold for generating affiliate payouts. Affiliate will not be paid until they earn at least this much.
- join_ip
- type: string
- custom1
- type: string
- max 255 characters
- custom2
- type: string
- max 255 characters
- custom3
- type: string
- max 255 characters
- custom4
- type: string
- max 255 characters
- custom5
- type: string
- max 255 characters
- status
- type: int
- Possible values: 0 - Active, 1 - Disabled, 2 - Banned, 3 - Wait on Verify, 4 - Pending, 5 - Denied
Example Request
POST
http://domain/api/affiliate/add_affiliate username = hello password = apitest firstname = hello lastname = test email = hello@n4n.com company = N4N url = natsfornetworks.com tel = 666-666-6666 icq = 666666666 aim = sixsixsix msn = sixsixtysix address1 = 666 666 st address2 = city = My City state = My State country = USA zip_code = 12345 tax_id_or_ssn = 54-1233245 ref = asdasd minimum_payout = 50 join_ip = 192.168.1.1 payvia=1
- Response:
[
{
"result":"Success","
"message":{
"loginid":"4003"
}
}
]
Example Code
PHP
<?php
$curl = curl_init();
$url = 'http://domain/api/affiliate/add_affiliate';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: productsupport'
);
$data = array(
'username' => 'hello3',
'password' => 'apitest',
'firstname' => 'hello',
'lastname' => 'test',
'email' => 'hello3@offerit.com',
'company' => 'Offerit',
'url' => 'offerit.com',
'tel' => '666-666-6666',
'icq' => '666666666',
'aim' => 'sixsixsix',
'msn' => 'sixsixtysix',
'address1' => '666 666 st',
'address2' => '',
'city' => 'My City',
'state' => 'My State',
'country' => 'USA',
'zip_code' => '12345',
'ref' => 'asdasd',
'join_ip' => '192.168.1.1',
'payvia' => '1', // Check payvia type
// notice the structure is an array of sub-arrays that have field/value pairs
'payvia_info' => Array(
Array(
'field' => 'Pay To',
'value' => 'Affiliate PayTo Name',
),
Array(
'field' => 'Address',
'value' => 'Affiliate Address',
),
),
);
$resp = curl_exec($curl);
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
//json was valid. Dump the decoded array
print_r($output);
}
else {
//invalid json, just dump the raw response
print_r($resp);
}
// Close request to clear up some resources
curl_close($curl);
?>
