Offerit REST API Set Affiliate Payvia Info

From Offerit
Jump to: navigation, search
Offerit
REST API
General
Offerit REST API Overview
GET /service/ping
Advertiser
PATCH /advertiser/edit_advertiser
POST /advertiser/add_advertiser
Affiliate
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
PATCH /affiliate/edit_affiliate
PATCH /affiliate/payvia
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
Creative
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
Offer
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
Reporting
GET /report/profitloss
GET /report/transaction
Transaction
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash

PATCH /affiliate/payvia

Description

  • The /affiliate/payvia action is a feature in Offerit that allows you to set the affiliate payvia info settings

Resource URL

  • http://domain/api/affiliate/payvia
  • Replace domain with the offerit domain

Request Method

  • PATCH

Response Format

  • JSON

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: is the affiliates loginid
    • type: string
    • required
  • payvia_type_id: is the id of the payvia that the loginid should be switched to
    • type: string
    • required
  • payvia_info: is an array containing arrays of info to update for the payvia type.
    • type: array
    • required

Example Request

PATCH

http://domain/api/affiliate/payvia

  • Response:
[
    {
        "field":"Payvia Type",
        "result":"Updated Payvia Type to 1 for loginid 1"
    },
    {
        "field":"Pay To",
        "result":"Updated Payvia Info: 'Pay To' is now 'TestPayTo'"
    },
    {
        "field":"Address",
        "result":"Updated Payvia Info: 'Address' is now 'Riga, Latvia'"
    }
]

Example Code

PHP

<?php
$curl = curl_init();

$payvia_info = array();
$payvia_info[] = array(
    'field' => 'Pay To',
    'value' => 'TestPayTo'
);
$payvia_info[] = array(
    'field' => 'Address',
    'value' => 'Riga, Latvia'
);

$data = array(
    'loginid' => 1,
    'payvia_type_id' => '1',
    'payvia_info' => $payvia_info
);

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

$headers = array(
    'api-key: 44b5498dbcb481a0d00b404c0169af62',
    'api-username: productsupport'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$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);
?>