curl --request POST \
--url https://api.exowpee.com/v1/catalog/pos-sync/registration-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"registration_key": "",
"name": "<string>",
"computer_id": "<string>",
"host_fingerprint": "<string>",
"organization_id": "<string>",
"company_id": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/catalog/pos-sync/registration-requests"
payload = {
"registration_key": "",
"name": "<string>",
"computer_id": "<string>",
"host_fingerprint": "<string>",
"organization_id": "<string>",
"company_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
registration_key: '',
name: '<string>',
computer_id: '<string>',
host_fingerprint: '<string>',
organization_id: '<string>',
company_id: '<string>'
})
};
fetch('https://api.exowpee.com/v1/catalog/pos-sync/registration-requests', 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://api.exowpee.com/v1/catalog/pos-sync/registration-requests",
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([
'registration_key' => '',
'name' => '<string>',
'computer_id' => '<string>',
'host_fingerprint' => '<string>',
'organization_id' => '<string>',
'company_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.exowpee.com/v1/catalog/pos-sync/registration-requests"
payload := strings.NewReader("{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.exowpee.com/v1/catalog/pos-sync/registration-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/catalog/pos-sync/registration-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"request_id": "<string>",
"request_token": "<string>",
"status": "<string>",
"poll_interval": 5
}
}{
"message": "<string>",
"errors": {}
}Request a POS registration
A new point-of-sale computer asks to be linked to an organization. It receives a request id and a secret token to follow the request until a manager approves it.
curl --request POST \
--url https://api.exowpee.com/v1/catalog/pos-sync/registration-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"registration_key": "",
"name": "<string>",
"computer_id": "<string>",
"host_fingerprint": "<string>",
"organization_id": "<string>",
"company_id": "<string>"
}
'import requests
url = "https://api.exowpee.com/v1/catalog/pos-sync/registration-requests"
payload = {
"registration_key": "",
"name": "<string>",
"computer_id": "<string>",
"host_fingerprint": "<string>",
"organization_id": "<string>",
"company_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
registration_key: '',
name: '<string>',
computer_id: '<string>',
host_fingerprint: '<string>',
organization_id: '<string>',
company_id: '<string>'
})
};
fetch('https://api.exowpee.com/v1/catalog/pos-sync/registration-requests', 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://api.exowpee.com/v1/catalog/pos-sync/registration-requests",
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([
'registration_key' => '',
'name' => '<string>',
'computer_id' => '<string>',
'host_fingerprint' => '<string>',
'organization_id' => '<string>',
'company_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.exowpee.com/v1/catalog/pos-sync/registration-requests"
payload := strings.NewReader("{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.exowpee.com/v1/catalog/pos-sync/registration-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.exowpee.com/v1/catalog/pos-sync/registration-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"registration_key\": \"\",\n \"name\": \"<string>\",\n \"computer_id\": \"<string>\",\n \"host_fingerprint\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"company_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"request_id": "<string>",
"request_token": "<string>",
"status": "<string>",
"poll_interval": 5
}
}{
"message": "<string>",
"errors": {}
}- The registration_key must be the organization’s POS registration key (26-character ULID); an unknown key is refused.
- organization_id and company_id are prohibited; the organization comes from the key.
- A computer that already has an active sync device in the organization, or an open request, is refused; the same applies to a host fingerprint.
- The route is limited to 5 calls per minute.
- A concurrent duplicate of an open request is refused with 409.
- Creates a pending registration request and returns a one-time request token to the device. The token is stored only as a hash.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The organization's POS registration key (26-character ULID). Required; it identifies the organization and must exist.
26Display name of the computer, up to 120 characters. Required.
120Stable identifier of the computer, up to 255 characters. Required; refused if the organization already has an active device or an open request for it.
255Fingerprint of the host, up to 255 characters. Required; stored only as a hash; refused if already used by an active device or open request.
255Identifier of the organization the record belongs to.
Identifier of the company the record belongs to.
Operating system: darwin, win32 or linux. Optional.
darwin, win32, linux Response
PosSyncInstanceRegistrationSubmissionResource
Items of this page.
Show child attributes
Show child attributes