Store a Signal Pixel bot score
curl --request POST \
--url https://api.botshield.ai/operations/sdk/store-signal \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"site_key": "<string>",
"score": 50,
"edge_score": 50,
"client_score": 50,
"fp_hash": "<string>",
"ip_hash": "<string>",
"ua_hash": "<string>",
"country": "<string>",
"signals": {}
}
'import requests
url = "https://api.botshield.ai/operations/sdk/store-signal"
payload = {
"site_key": "<string>",
"score": 50,
"edge_score": 50,
"client_score": 50,
"fp_hash": "<string>",
"ip_hash": "<string>",
"ua_hash": "<string>",
"country": "<string>",
"signals": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_key: '<string>',
score: 50,
edge_score: 50,
client_score: 50,
fp_hash: '<string>',
ip_hash: '<string>',
ua_hash: '<string>',
country: '<string>',
signals: {}
})
};
fetch('https://api.botshield.ai/operations/sdk/store-signal', 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.botshield.ai/operations/sdk/store-signal",
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([
'site_key' => '<string>',
'score' => 50,
'edge_score' => 50,
'client_score' => 50,
'fp_hash' => '<string>',
'ip_hash' => '<string>',
'ua_hash' => '<string>',
'country' => '<string>',
'signals' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.botshield.ai/operations/sdk/store-signal"
payload := strings.NewReader("{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.botshield.ai/operations/sdk/store-signal")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/sdk/store-signal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}"
response = http.request(request)
puts response.read_body{
"signal_token": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Signal Pixel
Store a Signal Pixel bot score
Stores a behavioral fingerprint score server-side and returns an opaque signal_token (bs_sig_…). The client-side score can be spoofed — the signal_token maps to the real score in BotShield’s database.
POST
/
sdk
/
store-signal
Store a Signal Pixel bot score
curl --request POST \
--url https://api.botshield.ai/operations/sdk/store-signal \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"site_key": "<string>",
"score": 50,
"edge_score": 50,
"client_score": 50,
"fp_hash": "<string>",
"ip_hash": "<string>",
"ua_hash": "<string>",
"country": "<string>",
"signals": {}
}
'import requests
url = "https://api.botshield.ai/operations/sdk/store-signal"
payload = {
"site_key": "<string>",
"score": 50,
"edge_score": 50,
"client_score": 50,
"fp_hash": "<string>",
"ip_hash": "<string>",
"ua_hash": "<string>",
"country": "<string>",
"signals": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_key: '<string>',
score: 50,
edge_score: 50,
client_score: 50,
fp_hash: '<string>',
ip_hash: '<string>',
ua_hash: '<string>',
country: '<string>',
signals: {}
})
};
fetch('https://api.botshield.ai/operations/sdk/store-signal', 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.botshield.ai/operations/sdk/store-signal",
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([
'site_key' => '<string>',
'score' => 50,
'edge_score' => 50,
'client_score' => 50,
'fp_hash' => '<string>',
'ip_hash' => '<string>',
'ua_hash' => '<string>',
'country' => '<string>',
'signals' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.botshield.ai/operations/sdk/store-signal"
payload := strings.NewReader("{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.botshield.ai/operations/sdk/store-signal")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/sdk/store-signal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_key\": \"<string>\",\n \"score\": 50,\n \"edge_score\": 50,\n \"client_score\": 50,\n \"fp_hash\": \"<string>\",\n \"ip_hash\": \"<string>\",\n \"ua_hash\": \"<string>\",\n \"country\": \"<string>\",\n \"signals\": {}\n}"
response = http.request(request)
puts response.read_body{
"signal_token": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
API key with Bearer prefix (e.g., 'Bearer bs_live_sk_...' or 'Bearer pk_live_...')
Body
application/json
⌘I