curl --request POST \
--url https://sandbox.axle.insure/platform/clients \
--header 'Content-Type: application/json' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"displayName": "Honda of Pawnee",
"entity": "superPlatform-honda-of-pawnee"
}
'import requests
url = "https://sandbox.axle.insure/platform/clients"
payload = {
"displayName": "Honda of Pawnee",
"entity": "superPlatform-honda-of-pawnee"
}
headers = {
"x-client-id": "<x-client-id>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({displayName: 'Honda of Pawnee', entity: 'superPlatform-honda-of-pawnee'})
};
fetch('https://sandbox.axle.insure/platform/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.axle.insure/platform/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => 'Honda of Pawnee',
'entity' => 'superPlatform-honda-of-pawnee'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-id: <x-client-id>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.axle.insure/platform/clients"
payload := strings.NewReader("{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.axle.insure/platform/clients")
.header("x-client-id", "<x-client-id>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.axle.insure/platform/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>"
}
}{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}{
"message": "Invalid credentials"
}{
"message": "Too Many Requests"
}Create Client
Create a destination client associated with your platform client. This request will return a destination client id that you can use to make requests to the Axle API on behalf of your destination clients.
See the Axle for Platforms guide for more information on how to use this endpoint and the destination client id.
curl --request POST \
--url https://sandbox.axle.insure/platform/clients \
--header 'Content-Type: application/json' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <api-key>' \
--data '
{
"displayName": "Honda of Pawnee",
"entity": "superPlatform-honda-of-pawnee"
}
'import requests
url = "https://sandbox.axle.insure/platform/clients"
payload = {
"displayName": "Honda of Pawnee",
"entity": "superPlatform-honda-of-pawnee"
}
headers = {
"x-client-id": "<x-client-id>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({displayName: 'Honda of Pawnee', entity: 'superPlatform-honda-of-pawnee'})
};
fetch('https://sandbox.axle.insure/platform/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.axle.insure/platform/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'displayName' => 'Honda of Pawnee',
'entity' => 'superPlatform-honda-of-pawnee'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-client-id: <x-client-id>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.axle.insure/platform/clients"
payload := strings.NewReader("{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.axle.insure/platform/clients")
.header("x-client-id", "<x-client-id>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.axle.insure/platform/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"displayName\": \"Honda of Pawnee\",\n \"entity\": \"superPlatform-honda-of-pawnee\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>"
}
}{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}{
"message": "Invalid credentials"
}{
"message": "Too Many Requests"
}Authorizations
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.
Headers
Your client ID. This will be shared with you during onboarding.
Body
The name of the destination client to display to users (e.g., Honda of Pawnee).
A standardized entity name for the destination client using all lowercase, and dashes instead of spaces. For example, yourPlatform-${yourCustomerId}. Entity names must be unique across all destination clients, and you will recieve a 409 response with a clear status message if the entity name has already been taken.
Note: Please keep in mind that the entity name may be public to your Ignition users, so it should not contain any sensitive information.
Was this page helpful?