Examples
C#
using System;
using System.Net.Http;
using System.Net.Http.Headers;
namespace testApi
{
class Program
{
string apiUrl = "https://live2api.bksblive2.co.uk/";
static void Main(string[] args)
{
string apiAccessKey = "YOUR_ACCESS_KEY";
string apiSecretKey = "YOUR_SECRET_KEY";
string apiResourceUrl = apiUrl + "api/userGroups/search";
//Http Client
HttpClient client = new HttpClient();
client.BaseAddress = new Uri(apiResourceUrl); //Base Url
// Add an Accept header for JSON format.
client.DefaultRequestHeaders.Accept.Add(
new MediaTypeWithQualityHeaderValue("application/json"));
// Add Authorization header
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", EncodeTo64(apiAccessKey + ":" + apiSecretKey));
// Response.
HttpResponseMessage response = client.GetAsync("?page=1&recordsPerPage=20&query=Afternoon Group").Result; // Url parameters
if (response.IsSuccessStatusCode)
{
// Success
Console.WriteLine("Success");
// Do something with the API response
}
else
{
// Error
Console.WriteLine("Error: StatusCode - " + response.StatusCode + ", ReasonPhrase - " + response.ReasonPhrase);
}
Console.ReadLine();
}
//Encode to Base 64
static public string EncodeTo64(string toEncode)
{
byte[] toEncodeAsBytes = System.Text.ASCIIEncoding.ASCII.GetBytes(toEncode);
string returnValue = System.Convert.ToBase64String(toEncodeAsBytes);
return returnValue;
}
}
}
VB
Imports System
Imports System.Net.Http
Imports System.Net.Http.Headers
Namespace testApi
Class Program
Private Shared Sub Main(args As String())
Dim apiAccessKey As String = "YOUR_ACCESS_KEY"
Dim apiSecretKey As String = "YOUR_SECRET_KEY"
' Http Client
Dim client As New HttpClient()
client.BaseAddress = New Uri("https://live2api.bksblive2.co.uk/api/userGroups/search") 'Base Url
' Add an Accept header for JSON format.
client.DefaultRequestHeaders.Accept.Add(New MediaTypeWithQualityHeaderValue("application/json"))
' Add Authorization header
client.DefaultRequestHeaders.Authorization = New AuthenticationHeaderValue("Basic", EncodeTo64(Convert.ToString(apiAccessKey & ":" & apiSecretKey))
' Response.
Dim response As HttpResponseMessage = client.GetAsync("?page=1&recordsPerPage=20&query=Afternoon Group").Result ' Url parameters
If response.IsSuccessStatusCode Then
' Success
' Do something with the API response
Console.WriteLine("Success")
Else
' Error
Console.WriteLine("Error: StatusCode - " + response.StatusCode + ", ReasonPhrase - " + response.ReasonPhrase)
End If
Console.ReadLine()
End Sub
'Encode to Base 64
Public Shared Function EncodeTo64(toEncode As String) As String
Dim toEncodeAsBytes As Byte() = System.Text.ASCIIEncoding.ASCII.GetBytes(toEncode)
Dim returnValue As String = System.Convert.ToBase64String(toEncodeAsBytes)
Return returnValue
End Function
End Class
End Namespace
JavaScript
Please note: We do not recommend calling api from JavaScript as this may reveal api access key details to the end user.
var apiUrl = apiUrl + "api/userGroups/search?page=1&recordsPerPage=20&query=Afternoon%20Group";
var apiAccessKey = "YOUR_ACCESS_KEY";
var apiSecretKey = "YOUR_SECRET_KEY";
$.ajax({
method: "GET",
url: apiUrl,
data: {},
beforeSend: function (xhr) {
xhr.setRequestHeader("Authorization", "Basic " + btoa(apiAccessKey + ":" + apiSecretKey));
}
}).done(function (data) {
// Success
// Do something with the API response
}).fail(function (err) {
// Error
});
/*
* Please note:
* 1. The btoa() method encodes a string in base-64.
* 2. You can send any JSON data required for the request using data : {}
*/
