API Example - Client Get Self

Problem

How do I retreive my own Partner details using the Partner API?
Getting my own (API GET) details using the RESTful Partner API based on on client id?

Solution

The following example of code shows you how to GET your own partner details. This is useful if you want to retrieve your Partner Credit balance.

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 Portal.

For Partner API reference documentation please see https://portal.my-engine.com/apidocs/index.html

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
/**
 * client-get-self.php
 * 
 * This example with do an API GET for the partner account itself.
 * You could also do a client-get.php with the id of the partner.
 * 
 */
$apiPartnerId = "<PartnerID>";
$apiSecretKey = "___PartnerKey___";

$apiUrl       = "https://sandbox.my-engine.com/api-v1/clients/self";

$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.
        echo "ClientID = " . $result['data']["id"] . $crlf;
        echo "Active Status = " . $result['data']["active"] . $crlf;
        echo "Client Verified Status = " . $result['data']["client_status_id"] . $crlf;
        echo "Client Type = " . $result['data']["client_type_id"] . $crlf;
        echo "Username = " . $result['data']["username"] . $crlf;
        echo "Email = " . $result['data']["email"] . $crlf;
        echo "Title = " . $result['data']["title"] . $crlf;
        echo "First = " . $result['data']["firstname"] . $crlf;
        echo "Surname = " . $result['data']["surname"] . $crlf;
        echo "Current Credit Balance = " . $result['data']["credit_balance"] . $crlf. $crlf;
        // For a full set of fields please refer to the API Documentation
    }
    
} 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);


/**
 * client-get-self.cs
 * 
 * This example with do an API GET for the partner account itself.
 * You could also do a client-get.php with the id of the partner.
 * 
 */


using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

namespace clients_get_self
{
    class Program
    {
        private const string apiPartnerId = "<PartnerID>";
        private const string apiSecretKey = "_PartnerKey_";

        private const string apiUrl = "https://sandbox.my-engine.com/api-v1/clients/self";

        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"))
                {
                    // View the entire record
                    // Console.WriteLine("data = {0}", item);

                    // Display the data we want.
                    Console.WriteLine("ClientID = {0}", details["data"]["id"]);
                    Console.WriteLine("Active Status = {0}", details["data"]["active"]);
                    Console.WriteLine("Client Verified Status = {0}", details["data"]["client_status_id"]);
                    Console.WriteLine("Client Type = {0}", details["data"]["client_type_id"]);
                    Console.WriteLine("Username = {0}", details["data"]["username"]);
                    Console.WriteLine("Email = {0}", details["data"]["email"]);
                    Console.WriteLine("Title = {0}", details["data"]["title"]);
                    Console.WriteLine("First = {0}", details["data"]["firstname"]);
                    Console.WriteLine("Surname = {0}", details["data"]["surname"]);
                    Console.WriteLine("Current Credit Balance = {0} \n", details["data"]["credit_balance"]);
                }
                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();
        }


    }
}


'
' client-get-self.vb
' 
' This example with do an API GET for the partner account itself.
' You could also do a client-get.php with the id of the partner.
' 
'

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/clients"

    Public Sub Main(args As String())
        clientsGetSelf().Wait()
    End Sub

    Public Async Function clientsGetSelf() 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
                ' Display the data we want.
                Console.WriteLine("ClientID = {0}", details("data")("id"))
                Console.WriteLine("Active Status = {0}", details("data")("active"))
                Console.WriteLine("Client Verified Status = {0}", details("data")("client_status_id"))
                Console.WriteLine("Client Type = {0}", details("data")("client_type_id"))
                Console.WriteLine("Username = {0}", details("data")("username"))
                Console.WriteLine("Email = {0}", details("data")("email"))
                Console.WriteLine("Title = {0}", details("data")("title"))
                Console.WriteLine("First = {0}", details("data")("firstname"))
                Console.WriteLine("Surname = {0}", details("data")("surname"))
                Console.WriteLine("Current Credit Balance = {0} {1}", details("data")("credit_balance"), vbCrLf)
            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


/**
 * client-get-self.js
 * 
 * This example with do an API GET for the partner account itself.
 * You could also do a client-get.php with the id of the partner.
 * 
 */

var apiPartnerId = "<PartnerID>";
var apiSecretKey = "_PartnerKey_";

var apiUrl = "https://sandbox.my-engine.com/api-v1/clients/self";
			  
// 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) {
        console.log("ClientID = " + response.data.id);
        console.log("Active Status = " + response.data.active);
        console.log("Client Verified Status = " + response.data.client_status_id);
        console.log("Client Type = " + response.data.client_type_id);
        console.log("Username = " + response.data.username);
        console.log("Email = " + response.data.email);
        console.log("Title = " + response.data.title);
        console.log("First = " + response.data.firstname);
        console.log("Surname = " + response.data.surname);
        console.log("Current Credit Balance = " + response.data.credit_balance);
        console.log(" ");

    })
    .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);
        }
    });

API Example - Client Get Self

Problem

Solution

Prerequisites

Example Code

Did you enjoy this article?

Disclaimer

Email Services

Internet Services

Resources

Company

Search

API Example - Client Get Self

Problem

Solution

Prerequisites

Example Code

Did you enjoy this article?

Disclaimer