Problem
How do I list what services (liveservices) are available to me as a Partner?
Using the Partner RESTful API how do I list the services available to me?
Getting my current Partner Tariff using the RESTful API.
Solution
The following example of code shows you how to list all the liveservices available to you as a Partner to resell. The list is subject to what tarif you are on.
Prerequisites
To use the Partner API you must meet the following criteria
- Have a working development environment.
- Have an active Partner account. If you need a partner account you can sign up here.
- Enabled your account to use the API and set the access controls.
- Have valid API Credentials.
- Optional - Setup your development environment to initially use the Sandbox Testing Poral.
Example Code
The examples below use the sandbox for testing. For a production environment remember to change the following:
- API Url
- Partner ID
- Partner API Key
<?php
/**
* liveservices-list-tariff.php
*
* This example with do an API GET against live-services and show all the services
* available to resell as a partner on your current tariff and the cost to the
* partner, shown in "partner credits".
*
*/
$apiPartnerId = "<PartnerID>";
$apiSecretKey = "___PartnerKey___";
$apiUrl = "https://sandbox.my-engine.com/api-v1/live_services/service_names";
$crlf = "<br />";
// Init Curl
$curl = curl_init();
// API Authentication:
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($curl, CURLOPT_USERPWD, "$apiPartnerId:$apiSecretKey");
// Set Curl Options
curl_setopt($curl, CURLOPT_URL, $apiUrl);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
// API GET
$jsonResult = curl_exec($curl);
// Check for a valid HTTP 200 success and process the returned result
// or handler the failure.
if (curl_getinfo($curl, CURLINFO_RESPONSE_CODE) == 200) {
$result = json_decode($jsonResult, true);
if (json_last_error() == JSON_ERROR_NONE) {
// We have valid Json data, so lets display the results.
foreach ($result['data'] as $liveservice) {
echo "Service Name = " . $liveservice["service_name"] . ", ";
echo "Cost (Credits) = " . $liveservice["credit_cost"] . $crlf;
}
}
} else {
echo "Response Code = " . curl_getinfo($curl, CURLINFO_RESPONSE_CODE) . $crlf;
$result = json_decode($jsonResult, true);
if (json_last_error() == JSON_ERROR_NONE) {
echo "error = " . $result["error"]["name"] . $crlf;
echo "url = " . $result["error"]["url"] . $crlf;
echo "message = " . $result["error"]["message"] . $crlf;
} else {
echo $jsonResult;
}
}
curl_close($curl);
/**
* liveservices-list-tariff.cs
*
* This example with do an API GET against live-services and show all the services
* available to resell as a partner on your current tariff and the cost to the
* partner, shown in "partner credits".
*
*/
using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
namespace liveservices-list-tariff
{
class Program
{
private const string apiPartnerId = "<PartnerID>";
private const string apiSecretKey = "_PartnerKey_";
private const string apiUrl = "https://sandbox.my-engine.com/api-v1/live_services/service_names";
static async Task Main(string[] args)
{
// Create HTTP resource
HttpClient client = new HttpClient();
// Add an Accept header for JSON format.
client.DefaultRequestHeaders.Add("ContentType", "application/json");
// Set the Authorisation
var authToken = System.Text.Encoding.UTF8.GetBytes(apiPartnerId + ":" + apiSecretKey);
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(authToken));
// Do the GET request.
HttpResponseMessage response = await client.GetAsync(apiUrl);
if (response.IsSuccessStatusCode)
{
var content = response.Content.ReadAsStringAsync();
dynamic details = JsonConvert.DeserializeObject(content.Result);
if (details.ContainsKey("data"))
{
foreach (var item in details["data"])
{
// View the entire record
// Console.WriteLine("data = {0}", item);
// Display the data we want.
Console.WriteLine("Service Name = {0}, Cost (Credits) = {1}", item["service_name"], item["credit_cost"]);
}
}
else
{
Console.WriteLine("response = {0}", response);
Console.WriteLine("json response = {0}", details);
}
}
else
{
// Get the Json Error response and convert it
var jsonResponseStr = response.Content.ReadAsStringAsync().Result;
dynamic jsonResponse = JsonConvert.DeserializeObject(jsonResponseStr);
Console.WriteLine("name = {0}", jsonResponse["error"]["name"]);
Console.WriteLine("url = {0}", jsonResponse["error"]["url"]);
Console.WriteLine("message = {0}", jsonResponse["error"]["message"]);
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
}
//Dispose once all HttpClient calls are complete.
client.Dispose();
}
}
}
'
' liveservices_list_tariff.vb
'
' This example with do an API GET against live-services and show all the services
' available to resell as a partner on your current tariff And the cost to the
' partner, shown in "partner credits".
'
'
Imports Newtonsoft.Json
Imports System
Imports System.Net.Http
Imports System.Net.Http.Headers
Imports System.Threading.Tasks
Module Program
Private Const apiPartnerId As String = "<PartnerID>"
Private Const apiSecretKey As String = "_PartnerKey_"
Private Const apiUrl As String = "https://sandbox.my-engine.com/api-v1/live_services/service_names"
Public Sub Main(args As String())
liveservicesListTariff().Wait()
End Sub
Public Async Function liveservicesListTariff() As Task
' Create HTTP resource
Dim client As New HttpClient()
' Add an Accept header for JSON format.
client.DefaultRequestHeaders.Add("ContentType", "application/json")
' Set the Authorisation
Dim authToken = System.Text.Encoding.UTF8.GetBytes(apiPartnerId + ":" + apiSecretKey)
client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(authToken))
' Do the GET request.
Dim response As HttpResponseMessage = Await client.GetAsync(apiUrl)
If response.IsSuccessStatusCode Then
Dim content = response.Content.ReadAsStringAsync()
Dim details As Object = JsonConvert.DeserializeObject(content.Result)
If details.ContainsKey("data") Then
For Each item In details("data")
' View the entire record
' Console.WriteLine("data = {0}", item)
' Display the data we want.
Console.WriteLine("Service Name = {0}, Cost (Credits) = {1}", item("service_name"), item("credit_cost"))
Next
Else
Console.WriteLine("response = {0}", response)
Console.WriteLine("json response = {0}", details)
End If
Else
' Get the Json Error response And convert it
Dim jsonResponseStr = response.Content.ReadAsStringAsync().Result
Dim jsonResponse As Object = JsonConvert.DeserializeObject(jsonResponseStr)
Console.WriteLine("name = {0}", jsonResponse("error")("name"))
Console.WriteLine("url = {0}", jsonResponse("error")("url"))
Console.WriteLine("message = {0}", jsonResponse("error")("message"))
Console.WriteLine("{0} ({1})", response.StatusCode, response.ReasonPhrase)
End If
'Dispose once all HttpClient calls are complete.
client.Dispose()
End Function
End Module
/**
* liveservices-list-tariff.js
*
* This example with do an API GET against live-services and show all the services
* available to resell as a partner on your current tariff and the cost to the
* partner, shown in "partner credits".
*
*/
var apiPartnerId = "<PartnerID>";
var apiSecretKey = "_PartnerKey_";
var apiUrl = "https://sandbox.my-engine.com/api-v1/live_services/service_names";
// Setup the Ajax request
var settings = {
url: apiUrl,
headers: {
'Authorization': 'Basic ' + btoa(apiPartnerId + ":" + apiSecretKey),
'cache-control': 'no-cache'
},
crossDomain: true,
dataType: 'json',
async: true,
method: "GET"
};
// API GET
$.ajax(settings)
.done(function(response) {
$.each(response.data, function(index, value) {
console.log("Service Name = " + value.service_name + ", Cost (Credits) = " + value.credit_cost);
});
})
.fail(function(request, textStatus, errorThrown) {
try {
var errObj = $.parseJSON(request.responseText);
console.log("API Error - " + errObj.name);
console.log("API Msg - " + errObj.message);
console.log("API url - " + errObj.url);
} catch (e) {
console.log("Error - " + errorThrown);
console.log("Status - " + request.status);
console.log(request);
}
});