cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"id": "3f2c1b9a-6d4e-4f8a-9b1c-2e7d5a8c0f41",
"name": "Example Platform"
}
{
"error": "unauthorized",
"message": "A platform token is required for this route."
}
Partner API
Get your platform
Return the platform your key belongs to.
GET
/
platform
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"id": "3f2c1b9a-6d4e-4f8a-9b1c-2e7d5a8c0f41",
"name": "Example Platform"
}
{
"error": "unauthorized",
"message": "A platform token is required for this route."
}
Returns the platform that owns the platform key. Use it to check that your key works and to read the platform ID and name Branduo has on file.
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Response
Your platform ID (UUID). The same ID you pass to the connect
link and the Embed plugin.
Your platform’s display name, as merchants see it in Branduo (for example on
Run your offer on {name}).
Errors
| Status | error | Cause |
|---|---|---|
401 | unauthorized | The platform key is missing or invalid. |
{
"id": "3f2c1b9a-6d4e-4f8a-9b1c-2e7d5a8c0f41",
"name": "Example Platform"
}
{
"error": "unauthorized",
"message": "A platform token is required for this route."
}

