OfferitRob at 16:22, 27 August 2018

2018-08-27T16:22:02Z

Offeritnick: /* Example Authentication */

2017-05-12T21:37:35Z

‎Example Authentication

OfferitRob at 20:45, 22 March 2017

2017-03-22T20:45:54Z

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == Overview == The Offerit REST API is accessible at http:///api// *The API i..."

2015-12-21T16:16:07Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == Overview == The Offerit REST API is accessible at <nowiki>http://<domain>/api/<endpoint>/<action></nowiki> *The API i..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}

== Overview ==
The Offerit REST API is accessible at <nowiki>http://<domain>/api/<endpoint>/<action></nowiki>
*The API is accessible to admins. '''/api/<endpoint>/<action> is available only to admins.'''
*Replace <domain> with your NATS install domain name.
*Replace <endpoint> with the endpoint that you are trying to access
*Some of the endpoints do not require <action> in the url and all of the urls will be specified in the documentation

== Allowed Endpoints ==

'''service'''
**'''''actions''''':
**[[Offerit REST API Ping| GET /service/ping]]

'''report'''
**'''''actions''''':
*[[Offerit_REST_API_Get_Profit_Loss_Report|GET /report/profitloss]]

'''transaction'''
**'''''actions''''':
*[[Offerit_REST_API_Get_Transaction_Payout_Preview|GET /transaction/transaction_payout_preview]]

== Gaining Access to the REST API ==
In order to access Offerit API your IP address must be in the ADMIN_API_ALLOWED_IPS list. You can add or remove IP addresses to this list via the Configurations Admin under the "Security" tab.

== Allowed HTTP Request Methods ==
*'''GET'''
*'''POST'''
*'''PUT'''
*'''PATCH'''

*For detailed information about these HTTP Request methods, please refer to their official documentation here:
**http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html

== Response Format ==
*[http://json.org/ '''JSON''']

== Response Status Codes ==
'''200'''
*On Success, the API will return a ''''200'''' status and output the results of the API call. Please refer to the available API endpoints for possible responses.
*NOTE: As long as the endpoint and HTTP request method are valid and there are no invalid parameters, a ''''200'''' response is returned.
'''400'''
*The API will return a ''''400'''' status if an invalid or unsupported HTTP request is sent.
'''404'''
*The API will return either a ''''404'''' status if an invalid parameter is sent, or if an HTTP request is sent to an invalid endpoint.
'''405'''
*The API will return a ''''405'''' status if an invalid HTTP request method is used.

== Authentication ==
*The Offerit REST API uses HTTP Header Authentication.
*Each REST API request requires the Affiliate username and the Affiliate API key to be sent with the HTTP headers of the request.
*To retrieve your API key simply select it from the login table of your Offerit database or put in a support ticket and we can retrieve it for you.
*If you do not have an API key, you can set one by going to the Affiliates Admin and clicking the icon labeled, "Change API Key".
*''Please note that only full admin accounts are authorized to use the API and set an API key.''

== Required HTTP Headers ==
*'''api-key''': ''Affiliate api key''
*'''api-username''': ''Affiliate user name''

**NOTE** The headers keys are NOT case sensitive.

== Example Authentication ==
Authentication can be handled in various ways using different programming languages. Below are some complete example calls to the Ping endpoint with HTTP Header authentication.

'''PHP'''
<pre>
<?php
$url = 'http://domain/api/ping'
$curl = curl_init();

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

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

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests

url = 'http://domain/api/ping'
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'productsupport'
}
params = {
'payvia_type_id': 1,
'rule_type': 'enabled'
}

res = requests.get(url, params=params, headers=headers)
print res.json()
</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

var options = {
url: 'http://domain/api/ping',
method: 'GET',
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'productsupport'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);
</pre>

'''Curl'''
<pre>
curl -X GET 'http://domain/api/ping' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: productsupport"
</pre>

And this is the output:
<pre>
true
</pre>

[[Category:Offerit API Articles]]

@@ Line 7: / Line 7: @@
 The Offerit REST API is accessible at <nowiki>http://<domain>/api/<endpoint>/<action></nowiki>
 *The API is accessible to admins. '''/api/<endpoint>/<action> is available only to admins.'''
-*Replace <domain> with your NATS install domain name.
+*Replace <domain> with your Offerit install domain name.
 *Replace <endpoint> with the endpoint that you are trying to access
 *Some of the endpoints do not require <action> in the url and all of the urls will be specified in the documentation

@@ Line 83: / Line 83: @@
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section= true
 }}

Offerit REST API Overview - Revision history

OfferitRob at 16:22, 27 August 2018

Offeritnick: /* Example Authentication */

OfferitRob at 20:45, 22 March 2017

OfferitDave: Created page with "{{Offerit Manual | show_api_admin_section = true }} == Overview == The Offerit REST API is accessible at http:///api// *The API i..."