NATS For Networks REST Edit Affiliate

From TMM Wiki
Revision as of 15:55, 19 April 2017 by Tmmdavid (talk | contribs) (Created page with "{{NATS For Networks Manual | show_api_admin_section = true }} == '''PATCH /affiliate/edit_affiliate ''' == '''Description''' *edit_affiliate edits an existing affiliate a...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Template:NATS For Networks Manual

PATCH /affiliate/edit_affiliate

Description

  • edit_affiliate edits an existing affiliate account


Resource URL

  • http://domain/api/affiliate/edit_affiliate
  • Replace domain with the NATS For Networks domain

Response Format

  • JSON

Request Method

  • PATCH

Authentication

  • HTTP headers

Parameters

Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded

  • loginid
    • type: string
    • required
    • Id of affiliate to edit
  • password
    • type: string
    • required
    • Affiliate Password
  • payvia
    • type: int
    • required
    • Payvia type id of the payvia type to use with this affiliate
  • 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
  • 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


Example Request

PATCH


http://domain/api/affiliate/edit_affiliate
loginid = 4002
password = apitest
firstname = hello
lastname = test
email = hello@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



  • Response:
[
    {
        "result":"Success","
    }
]

Example Code

PHP

<?php
$curl = curl_init();

$url = 'http://domain/api/affiliate/edit_affiliate';

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);

$data = array(
    'loginid' => 4002,
    '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',
    'join_ip' => '192.168.1.1',
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));    

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>