Documentazione: API di AffiliationSoftware - AffiliationSoftware

API di AffiliationSoftware

In questa pagina

Cos'è

AffiliationSoftware dispone di un API (Application Programming Interface) che consente agli sviluppatori di interfacciarsi con il network di affiliazione e svolgere determinate azioni in modo autonomo. È possibile ad esempio approvare o rifiutare automaticamente le transazioni degli affiliati in base allo stato dell’ordine, iscrivere automaticamente un affiliato quando si registra al tuo sito, e molto altro ancora.


Come funziona

L’API di AffiliationSoftware si può richiamare usando la funzione cURL e inviando i dati via POST. Il risultato di ogni chiamata restituisce un messaggio in JSON. Per utilizzare l'API è necessario usare il tuo URL e la tue chiave, che trovi sotto impostazioni nel pannello admin.


Chiamate API

Di seguito sono elencate tutte le chiamate API attualmente disponibili e i codici da usare per effettuare queste chiamate con la funzione cURL di PHP.

Approvare una transazione
Modificare una transazione
Modificare un affiliato
Iscrivere un affiliato
Leggere i dati dell'affiliato
Aggiungere una relazione
Modificare una realzione
Leggere le statistiche
Iscrivere un advertiser
Aggiungere un banner/link
Modificare un banner/link
Inserire una campagna
Modificare una campagna
Inserire una commissione
Modificare una commission
Eliminare una commissione


Approvare una transazione

<?php
$data = array(
  'action' => 'transaction_status',
  'transaction' => 'xxx', // inserisci l’ID o l’orderID della transazione 
  'status' => '1', // inserisci lo stato (1 = approvata, 2 = rifiutata)
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Modificare una transazione

<?php
$data = array(
  'action' => 'transaction_edit',
  'transaction' => 'xxx', // inserisci l’ID o l’orderID della transazione 
  'field' => 'orderid', // campi: status, amount, cost, orderid, channel, channel2, channel3, note
  'value' => 'xxx', // valore da inserire
  'field2' => 'channel', // facoltativo, fino a 10 campi
  'value2' => 'xxx', 
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Modificare un affiliato

<?php
$data = array(
  'action' => 'affiliate_edit',
  'affiliate' => 'xxx', // inserisci l’ID o l’email dell’affiliato
  'field' => 'status', // colonne: name, email, password, status, note
  'value' => '1', // valore da inserire
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Iscrivere un affiliato

<?php
$data = array(
  'action' => 'affiliate_add',
  'name' => 'Affiliate name', // obbligatorio
  'email' => 'test@test.com', // obbligatorio
  'password' => 'test123', // facoltativo
  'parent' => '', // facoltativo
  'status' => 1, // facoltativo
  'language' => 'it', // facoltativo
  'notes' => '', // facoltativo
  'data1' => '', // facoltativo 
  'data2' => '', // facoltativo 
  // ...
  'data25' => '', // facoltativo
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Leggere i dati dELL'affiliato

<?php
$data = array(
  'action' => 'affiliate_data',
  'affiliate' => 'xxx', // inserisci l’ID o l’email dell’affiliato
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Aggiungere una relazione

<?php
$data = array(
'action' => 'relation_add',
'affiliate' => 'xxx', // inserisci l’ID o l’email dell’affiliato
'campaign' => 'xxx', // inserisci l'ID della campagna
'status' => 1, // facoltativo
'segment' => 'default', // facoltativo
'notes' => '', // facoltativo
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Modificare una relazione

<?php
$data = array(
'action' => 'relation_edit',
'affiliate' => 'xxx', // inserisci l’ID o l’email dell’affiliato
'campaign' => 'xxx', // inserisci l'ID della campagna
'field' => 'status', // obbligatorio (colonne: status, segment, notes)
'value' => 2, // obbligatorio
'field2' => 'segment', // facoltativo
'value2' => 'NewGroup95', // facoltativo
'field3' => 'notes', // facoltativo
'value3' => 'test note', // facoltativo
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Leggere le statistiche

<?php
$data = array(
  'action' => 'affiliate_stats',
  'from' => 'YYYY-MM-DD', // inserisci la data d’inizio
  'to' => 'YYYY-MM-DD', // inserisci la data d’inizio
  'affiliate' => 'xxx', // inserisci l’ID o l’email dell’affiliato (facoltativo)
  'campaign' => 'xxx', // inserisci l’ID della campagna (facoltativo)
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


ISCRIVERE UN ADVERTISER

<?php
$data = array(
  'action' => 'advertiser_add',
  'name' => 'Advertiser name', // obbligatorio
  'email' => 'test@test.com', // obbligatorio
  'password' => 'test123', // facoltativo
  'status' => 1, // facoltativo
  'language' => 'it', // facoltativo
  'manage_transactions' => 1, // facoltativo
  'manage_affiliates' => 1, // facoltativo
  'notes' => '', // facoltativo
  'data1' => '', // facoltativo 
  'data2' => '', // facoltativo 
  // ...
  'data25' => '', // facoltativo
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


<?php
$data = array(
'action' => 'banner_add',
'campaign' => 'XXX', // required
'type' => 'L', // required (Link, Text, Image, Hover, Code, Email, Deeplink, QR)
'name' => 'Banner name', // required
'status' => 1, // optional
'language' => '', // optional
'url' => 'http://example.com', // required
'width' => '', // optional
'height' => '', // optional
'image' => '', // optional
'code' => '', // optional
'description' => '', // optional
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


<?php
$data = array(
'action' => 'banner_edit',
'banner' => 'XXX', // required
'field' => 'url', // required
'value' => 'http://example.com', // required
'field2' => 'image', // optional
'value2' => 'http://example.com', // optional
'field3' => 'status', // optional
'value3' => 2, // optional
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Inserire una campagna

<?php
$data = array(
'action' => 'campaign_add',
'name' => 'campaign name', // required
'description' => '', // optional (HTML allowed)
'slogan' => '',  // optional
'logo' => '', // optional
'category' => '', // optional
'notes' => '', // optional
'status' => '1', // optional
'sort' => 0, // optional
'advertiser' => '', // optional
'geotarget' => 'us,uk', // optional (plugin required)
'featured' => 1, // optional (plugin required)
'directlink' => '1', // optional (plugin required)
't3pp_postback' => '1', // optional (plugin required)
't3pp_pixel' => '1', // optional (plugin required)
't3pp_code' => '1', // optional (plugin required)
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Modificare una campagna

<?php
$data = array(
'action' => 'campaign_edit',
'campaign' => 'xczxy0', // required
'field' => 'status', // required
'value' => '1', // required
'field2' => 'name', // optional
'value2' => 'new name here', // optional
'field3' => 'slogan', // optional
'value3' => 'new slogan here', // optional
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Inserire una commissione

<?php
$data = array(
'action' => 'commission_add',
'campaign' => 'XXX', // required
'type' => 'L', // required
'segment' => 'default', // optional
'commission' => '2.50', // required
'commission2' => '0.50', // optional
// ...
'commission10' => '0', // optional
'percentage' => 0, // optional
'hide' => 1, // optional
'gross' => 0, // optional (plugin required)
'recurring' => '', // optional (plugin required)
'freetrial' => '', // optional (plugin required)
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Modificare una commissione

<?php
$data = array(
'action' => 'commission_edit',
'campaign' => 'XXX', // required
'type' => 'S', // required
'segment' => 'default', // optional
'commission' => '10', // optional
'commission2' => '0', // optional
// ...
'commission10' => 0, // optional
'percentage' => 0, // optional
'hide' => 0, // optional
'gross' => 0, // optional (plugin required)
'recurring' => '', // optional (plugin required)
'freetrial' => '', // optional (plugin required)
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>


Eliminare una commissione

<?php
$data = array(
'action' => 'commission_delete',
'campaign' => 'XXX', // required
'type' => 'S', // required
'segment' => 'default', // optional
);
$api = curl_init( 'http://esempio.com/script/api?key=xxx' ); // inserisci il tuo URL 
curl_setopt( $api, CURLOPT_POST, 1 );
curl_setopt( $api, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $api, CURLOPT_POSTFIELDS, $data );
$res = curl_exec( $api );
curl_close( $api );
print_r( json_decode( $res, true ) );
?>

Torna indietro