Introduction
Binated Prolink API Documentation
This documentation aims to provide all the information you need to work with our API.
Base URL
https://binated.comAuthenticating requests
This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
You can retrieve your token by visiting your dashboard and clicking Generate API token.
Endpoints
Display a listing of the resource.
requires authentication
Example request:
curl --request GET \
--get "https://binated.com/api/orders" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://binated.com/api/orders"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://binated.com/api/orders',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
POST api/orders
requires authentication
Example request:
curl --request POST \
"https://binated.com/api/orders" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"decoration\": \"voluptates\",
\"priority\": \"et\",
\"description\": \"quis\",
\"reference\": \"animi\",
\"colors\": \"tempora\",
\"background_color\": \"maxime\",
\"height\": \"in\",
\"width\": \"vitae\",
\"placement\": \"quo\",
\"process_type\": \"qui\",
\"art_type\": \"quia\",
\"product_sku\": \"est\",
\"product_vendor\": \"quod\",
\"cap\": true,
\"sewout_logo_recreation\": true,
\"output_file_format\": \"ipsa\",
\"instructions\": \"sit\",
\"media\": \"illo\",
\"color_code\": \"qui\",
\"style_master\": \"est\"
}"
const url = new URL(
"https://binated.com/api/orders"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"decoration": "voluptates",
"priority": "et",
"description": "quis",
"reference": "animi",
"colors": "tempora",
"background_color": "maxime",
"height": "in",
"width": "vitae",
"placement": "quo",
"process_type": "qui",
"art_type": "quia",
"product_sku": "est",
"product_vendor": "quod",
"cap": true,
"sewout_logo_recreation": true,
"output_file_format": "ipsa",
"instructions": "sit",
"media": "illo",
"color_code": "qui",
"style_master": "est"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://binated.com/api/orders',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'decoration' => 'voluptates',
'priority' => 'et',
'description' => 'quis',
'reference' => 'animi',
'colors' => 'tempora',
'background_color' => 'maxime',
'height' => 'in',
'width' => 'vitae',
'placement' => 'quo',
'process_type' => 'qui',
'art_type' => 'quia',
'product_sku' => 'est',
'product_vendor' => 'quod',
'cap' => true,
'sewout_logo_recreation' => true,
'output_file_format' => 'ipsa',
'instructions' => 'sit',
'media' => 'illo',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Display the specified resource.
requires authentication
Example request:
curl --request GET \
--get "https://binated.com/api/orders/illum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://binated.com/api/orders/illum"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://binated.com/api/orders/illum',
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error: