Registrar um dispositivo para uma entidade

Criar

curl --request POST \
  --url http://api.gu1.ai/devices/entity/{entityId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceId": "<string>",
  "entityType": "<string>",
  "entityExternalId": "<string>",
  "entityTaxId": "<string>",
  "platform": "<string>",
  "manufacturer": "<string>",
  "model": "<string>",
  "brand": "<string>",
  "deviceName": "<string>",
  "osVersion": "<string>",
  "systemName": "<string>",
  "systemVersion": "<string>",
  "browser": "<string>",
  "browserVersion": "<string>",
  "latitude": 123,
  "longitude": 123,
  "city": "<string>",
  "region": "<string>",
  "country": "<string>",
  "countryCode": "<string>",
  "ipAddress": "<string>",
  "isEmulator": true,
  "isRooted": true
}
'

import requests

url = "http://api.gu1.ai/devices/entity/{entityId}"

payload = {
    "deviceId": "<string>",
    "entityType": "<string>",
    "entityExternalId": "<string>",
    "entityTaxId": "<string>",
    "platform": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "brand": "<string>",
    "deviceName": "<string>",
    "osVersion": "<string>",
    "systemName": "<string>",
    "systemVersion": "<string>",
    "browser": "<string>",
    "browserVersion": "<string>",
    "latitude": 123,
    "longitude": 123,
    "city": "<string>",
    "region": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "ipAddress": "<string>",
    "isEmulator": True,
    "isRooted": True
}
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({
    deviceId: '<string>',
    entityType: '<string>',
    entityExternalId: '<string>',
    entityTaxId: '<string>',
    platform: '<string>',
    manufacturer: '<string>',
    model: '<string>',
    brand: '<string>',
    deviceName: '<string>',
    osVersion: '<string>',
    systemName: '<string>',
    systemVersion: '<string>',
    browser: '<string>',
    browserVersion: '<string>',
    latitude: 123,
    longitude: 123,
    city: '<string>',
    region: '<string>',
    country: '<string>',
    countryCode: '<string>',
    ipAddress: '<string>',
    isEmulator: true,
    isRooted: true
  })
};

fetch('http://api.gu1.ai/devices/entity/{entityId}', 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 => "http://api.gu1.ai/devices/entity/{entityId}",
  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([
    'deviceId' => '<string>',
    'entityType' => '<string>',
    'entityExternalId' => '<string>',
    'entityTaxId' => '<string>',
    'platform' => '<string>',
    'manufacturer' => '<string>',
    'model' => '<string>',
    'brand' => '<string>',
    'deviceName' => '<string>',
    'osVersion' => '<string>',
    'systemName' => '<string>',
    'systemVersion' => '<string>',
    'browser' => '<string>',
    'browserVersion' => '<string>',
    'latitude' => 123,
    'longitude' => 123,
    'city' => '<string>',
    'region' => '<string>',
    'country' => '<string>',
    'countryCode' => '<string>',
    'ipAddress' => '<string>',
    'isEmulator' => true,
    'isRooted' => true
  ]),
  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 := "http://api.gu1.ai/devices/entity/{entityId}"

	payload := strings.NewReader("{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\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("http://api.gu1.ai/devices/entity/{entityId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/devices/entity/{entityId}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "device": {
    "device.id": "<string>",
    "device.deviceId": "<string>",
    "device.externalId": "<string>",
    "device.entityId": "<string>",
    "device.entityExternalId": "<string>",
    "device.entityTaxId": "<string>",
    "device.platform": "<string>",
    "device.manufacturer": "<string>",
    "device.model": "<string>",
    "device.brand": "<string>",
    "device.deviceName": "<string>",
    "device.deviceDetails": {},
    "device.osName": "<string>",
    "device.osVersion": "<string>",
    "device.browser": "<string>",
    "device.browserVersion": "<string>",
    "device.latitude": 123,
    "device.longitude": 123,
    "device.city": "<string>",
    "device.region": "<string>",
    "device.country": "<string>",
    "device.countryCode": "<string>",
    "device.ipAddress": "<string>",
    "device.isEmulator": true,
    "device.isRooted": true,
    "device.isBlocked": true,
    "device.isTrusted": true,
    "device.firstSeenAt": "<string>",
    "device.lastSeenAt": "<string>",
    "device.createdAt": "<string>",
    "device.updatedAt": "<string>"
  }
}

POST

devices

entity

{entityId}

Criar

curl --request POST \
  --url http://api.gu1.ai/devices/entity/{entityId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deviceId": "<string>",
  "entityType": "<string>",
  "entityExternalId": "<string>",
  "entityTaxId": "<string>",
  "platform": "<string>",
  "manufacturer": "<string>",
  "model": "<string>",
  "brand": "<string>",
  "deviceName": "<string>",
  "osVersion": "<string>",
  "systemName": "<string>",
  "systemVersion": "<string>",
  "browser": "<string>",
  "browserVersion": "<string>",
  "latitude": 123,
  "longitude": 123,
  "city": "<string>",
  "region": "<string>",
  "country": "<string>",
  "countryCode": "<string>",
  "ipAddress": "<string>",
  "isEmulator": true,
  "isRooted": true
}
'

import requests

url = "http://api.gu1.ai/devices/entity/{entityId}"

payload = {
    "deviceId": "<string>",
    "entityType": "<string>",
    "entityExternalId": "<string>",
    "entityTaxId": "<string>",
    "platform": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "brand": "<string>",
    "deviceName": "<string>",
    "osVersion": "<string>",
    "systemName": "<string>",
    "systemVersion": "<string>",
    "browser": "<string>",
    "browserVersion": "<string>",
    "latitude": 123,
    "longitude": 123,
    "city": "<string>",
    "region": "<string>",
    "country": "<string>",
    "countryCode": "<string>",
    "ipAddress": "<string>",
    "isEmulator": True,
    "isRooted": True
}
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({
    deviceId: '<string>',
    entityType: '<string>',
    entityExternalId: '<string>',
    entityTaxId: '<string>',
    platform: '<string>',
    manufacturer: '<string>',
    model: '<string>',
    brand: '<string>',
    deviceName: '<string>',
    osVersion: '<string>',
    systemName: '<string>',
    systemVersion: '<string>',
    browser: '<string>',
    browserVersion: '<string>',
    latitude: 123,
    longitude: 123,
    city: '<string>',
    region: '<string>',
    country: '<string>',
    countryCode: '<string>',
    ipAddress: '<string>',
    isEmulator: true,
    isRooted: true
  })
};

fetch('http://api.gu1.ai/devices/entity/{entityId}', 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 => "http://api.gu1.ai/devices/entity/{entityId}",
  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([
    'deviceId' => '<string>',
    'entityType' => '<string>',
    'entityExternalId' => '<string>',
    'entityTaxId' => '<string>',
    'platform' => '<string>',
    'manufacturer' => '<string>',
    'model' => '<string>',
    'brand' => '<string>',
    'deviceName' => '<string>',
    'osVersion' => '<string>',
    'systemName' => '<string>',
    'systemVersion' => '<string>',
    'browser' => '<string>',
    'browserVersion' => '<string>',
    'latitude' => 123,
    'longitude' => 123,
    'city' => '<string>',
    'region' => '<string>',
    'country' => '<string>',
    'countryCode' => '<string>',
    'ipAddress' => '<string>',
    'isEmulator' => true,
    'isRooted' => true
  ]),
  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 := "http://api.gu1.ai/devices/entity/{entityId}"

	payload := strings.NewReader("{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\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("http://api.gu1.ai/devices/entity/{entityId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/devices/entity/{entityId}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deviceId\": \"<string>\",\n  \"entityType\": \"<string>\",\n  \"entityExternalId\": \"<string>\",\n  \"entityTaxId\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"manufacturer\": \"<string>\",\n  \"model\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"deviceName\": \"<string>\",\n  \"osVersion\": \"<string>\",\n  \"systemName\": \"<string>\",\n  \"systemVersion\": \"<string>\",\n  \"browser\": \"<string>\",\n  \"browserVersion\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"city\": \"<string>\",\n  \"region\": \"<string>\",\n  \"country\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"ipAddress\": \"<string>\",\n  \"isEmulator\": true,\n  \"isRooted\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "device": {
    "device.id": "<string>",
    "device.deviceId": "<string>",
    "device.externalId": "<string>",
    "device.entityId": "<string>",
    "device.entityExternalId": "<string>",
    "device.entityTaxId": "<string>",
    "device.platform": "<string>",
    "device.manufacturer": "<string>",
    "device.model": "<string>",
    "device.brand": "<string>",
    "device.deviceName": "<string>",
    "device.deviceDetails": {},
    "device.osName": "<string>",
    "device.osVersion": "<string>",
    "device.browser": "<string>",
    "device.browserVersion": "<string>",
    "device.latitude": 123,
    "device.longitude": 123,
    "device.city": "<string>",
    "device.region": "<string>",
    "device.country": "<string>",
    "device.countryCode": "<string>",
    "device.ipAddress": "<string>",
    "device.isEmulator": true,
    "device.isRooted": true,
    "device.isBlocked": true,
    "device.isTrusted": true,
    "device.firstSeenAt": "<string>",
    "device.lastSeenAt": "<string>",
    "device.createdAt": "<string>",
    "device.updatedAt": "<string>"
  }
}

Visão Geral

Registre manualmente um dispositivo para uma entidade específica. Este endpoint permite adicionar informações de dispositivo quando não são capturadas automaticamente através de eventos, útil para migrações de dados, testes ou fluxos de registro manual.

Registro Automático: Na maioria dos casos, dispositivos são registrados automaticamente quando você cria eventos de usuário com informações de dispositivo. O registro manual é tipicamente necessário apenas para:

Migração de dados de dispositivos existentes
Testes e desenvolvimento
Preenchimento retroativo de registros históricos de dispositivos

Endpoint

POST https://api.gu1.ai/devices/entity/{entityId}

Autenticação

Requer uma chave de API válida no cabeçalho Authorization:

Authorization: Bearer YOUR_API_KEY

Parâmetros de Caminho

string

required

UUID da entidade para associar este dispositivo

Corpo da Requisição

string

required

Identificador único para este dispositivo. Deve ser um identificador estável que persiste entre sessões (ex: impressão digital do dispositivo, IMEI, ID de publicidade)

string

Tipo da entidade para auditoria. Opções: person, company. Padrão: "person"

string

ID externo da entidade (identificador do seu sistema). Armazenado desnormalizado no dispositivo para consultas.

string

Tax ID da entidade (ex: CUIT, CPF). Armazenado desnormalizado no dispositivo para consultas.

string

Plataforma do dispositivo. Opções:

android - Dispositivo Android
ios - Dispositivo iOS
web - Navegador web

Exemplo: "android"

string

Nome do fabricante do dispositivo (ex: “samsung”, “Apple”, “Google”)

string

Identificador do modelo do dispositivo (ex: “SM-A156M”, “iPhone 15 Pro”, “Pixel 8”)

string

Nome da marca do dispositivo (ex: “samsung”, “Apple”)

string

Nome do dispositivo definido pelo usuário ou nome do hardware

string

Versão do sistema operacional (ex: “Android 16”, “iOS 17.2”, “Windows 11”)

string

Nome do sistema para dispositivos iOS (ex: “iOS”)

string

Versão do sistema para dispositivos iOS (ex: “17.2”)

string

Nome do navegador para plataforma web (ex: “Chrome”, “Safari”, “Firefox”)

string

Versão do navegador para plataforma web (ex: “120.0.6099.129”)

number

Coordenada de latitude geográfica (-90 a 90)Exemplo: -34.6037

number

Coordenada de longitude geográfica (-180 a 180)Exemplo: -58.3816

string

Nome da cidade (ex: “Buenos Aires”, “Nova York”, “Londres”)

string

Estado ou província (ex: “Buenos Aires”, “Califórnia”, “Ontário”)

string

Nome do país (ex: “Argentina”, “Estados Unidos”, “Canadá”)

string

Código de país ISO 3166-1 alpha-2 (ex: “AR”, “US”, “CA”)

string

Endereço IP (IPv4 ou IPv6) de onde o dispositivo está acessandoExemplo: "10.40.64.231"

boolean

default:"false"

Se este dispositivo foi detectado como emulador ou simulador

boolean

default:"false"

Se este dispositivo tem root (Android) ou jailbreak (iOS)

Resposta

boolean

Indica se a requisição foi bem-sucedida

object

O objeto do dispositivo criado

string

UUID interno do dispositivo no gu1

string

Seu identificador de dispositivo fornecido

string

Identificador externo do dispositivo (mesmo que deviceId)

string

UUID da entidade associada

string

ID externo da entidade (desnormalizado)

string

Tax ID da entidade (desnormalizado)

string

Plataforma do dispositivo (android, ios, web)

string

Fabricante do dispositivo

string

Modelo do dispositivo

string

Marca do dispositivo

string

Nome do dispositivo definido pelo usuário ou nome do hardware

object

Metadados adicionais do dispositivo (objeto JSON). Por plataforma: Android (hardware, buildId, sdkVersion), iOS (systemName, identifierForVendor), Web (userAgent, etc.)

string

Nome do sistema operacional

string

Versão do sistema operacional

string

Nome do navegador (somente web)

string

Versão do navegador (somente web)

number

Latitude geográfica

number

Longitude geográfica

string

Nome da cidade

string

Estado/província

string

Nome do país

string

Código do país ISO

string

Endereço IP

boolean

Flag de detecção de emulador

boolean

Flag de detecção de root/jailbreak

boolean

Se o dispositivo está bloqueado

boolean

Se o dispositivo está marcado como confiável

string

Primeira vez que o dispositivo foi visto (timestamp ISO 8601)

string

Última vez que o dispositivo foi visto (timestamp ISO 8601)

string

Timestamp de criação do registro do dispositivo

string

Timestamp da última atualização do registro do dispositivo

Exemplos

curl -X POST https://api.gu1.ai/devices/entity/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "deviceId": "840e89e4d46efd67",
    "platform": "android",
    "manufacturer": "samsung",
    "model": "SM-A156M",
    "brand": "samsung",
    "osVersion": "Android 16",
    "city": "Buenos Aires",
    "region": "Buenos Aires",
    "country": "Argentina",
    "countryCode": "AR",
    "latitude": -34.6037,
    "longitude": -58.3816,
    "ipAddress": "10.40.64.231"
  }'

const response = await fetch('https://api.gu1.ai/devices/entity/550e8400-e29b-41d4-a716-446655440000', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    deviceId: '840e89e4d46efd67',
    platform: 'android',
    manufacturer: 'samsung',
    model: 'SM-A156M',
    brand: 'samsung',
    osVersion: 'Android 16',
    city: 'Buenos Aires',
    region: 'Buenos Aires',
    country: 'Argentina',
    countryCode: 'AR',
    latitude: -34.6037,
    longitude: -58.3816,
    ipAddress: '10.40.64.231'
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    'https://api.gu1.ai/devices/entity/550e8400-e29b-41d4-a716-446655440000',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'deviceId': '840e89e4d46efd67',
        'platform': 'android',
        'manufacturer': 'samsung',
        'model': 'SM-A156M',
        'brand': 'samsung',
        'osVersion': 'Android 16',
        'city': 'Buenos Aires',
        'region': 'Buenos Aires',
        'country': 'Argentina',
        'countryCode': 'AR',
        'latitude': -34.6037,
        'longitude': -58.3816,
        'ipAddress': '10.40.64.231'
    }
)

data = response.json()
print(data)

Exemplo de Resposta

{
  "success": true,
  "device": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "deviceId": "840e89e4d46efd67",
    "externalId": "840e89e4d46efd67",
    "entityId": "550e8400-e29b-41d4-a716-446655440000",
    "entityExternalId": null,
    "entityTaxId": null,
    "deviceName": null,
    "deviceDetails": {},
    "platform": "android",
    "manufacturer": "samsung",
    "model": "SM-A156M",
    "brand": "samsung",
    "osName": "Android",
    "osVersion": "Android 16",
    "browser": null,
    "browserVersion": null,
    "latitude": -34.6037,
    "longitude": -58.3816,
    "city": "Buenos Aires",
    "region": "Buenos Aires",
    "country": "Argentina",
    "countryCode": "AR",
    "ipAddress": "10.40.64.231",
    "isEmulator": false,
    "isRooted": false,
    "isBlocked": false,
    "isTrusted": false,
    "firstSeenAt": "2026-01-30T10:00:00Z",
    "lastSeenAt": "2026-01-30T10:00:00Z",
    "createdAt": "2026-01-30T10:00:00Z",
    "updatedAt": "2026-01-30T10:00:00Z"
  }
}

Respostas de Erro

400 Bad Request

{
  "success": false,
  "error": {
    "code": "MISSING_DEVICE_ID",
    "message": "Device ID is required"
  }
}

401 Unauthorized

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Forbidden

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions to create devices"
  }
}

404 Not Found

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity with ID 550e8400-e29b-41d4-a716-446655440000 not found"
  }
}

500 Internal Server Error

{
  "success": false,
  "error": {
    "code": "DEVICE_CREATE_FAILED",
    "message": "Failed to create device"
  }
}

Casos de Uso

Testar Regras de Fraude

Crie dispositivos de teste com características específicas para verificar se suas regras de detecção de fraude funcionam corretamente:

// Criar um dispositivo suspeito para testes
await createDevice({
  deviceId: 'test_emulator_001',
  platform: 'android',
  isEmulator: true,
  isRooted: true
});

Migração de Dados

Migre dados históricos de dispositivos do seu sistema existente:

// Importação em massa de dispositivos do sistema legado
for (const legacyDevice of legacyDevices) {
  await createDevice({
    deviceId: legacyDevice.id,
    platform: legacyDevice.platform,
    manufacturer: legacyDevice.manufacturer,
    model: legacyDevice.model,
    city: legacyDevice.location.city,
    country: legacyDevice.location.country
  });
}

Registro Manual de Dispositivo

Permita que clientes registrem seus dispositivos manualmente:

// Cliente adiciona manualmente um novo dispositivo confiável
await createDevice({
  deviceId: deviceFingerprint,
  platform: 'web',
  browser: 'Chrome',
  browserVersion: '120.0',
  city: userLocation.city,
  country: userLocation.country
});

Próximos Passos

Listar Dispositivos

Consultar dispositivos de uma entidade

API de Eventos

Registrar dispositivos automaticamente via eventos

Visão geral da API de dispositivos Listar dispositivos de uma entidade

⌘I

​Visão Geral

​Endpoint

​Autenticação

​Parâmetros de Caminho

​Corpo da Requisição

​Resposta

​Exemplos

​Exemplo de Resposta

​Respostas de Erro

​400 Bad Request

​401 Unauthorized

​403 Forbidden

​404 Not Found

​500 Internal Server Error

​Casos de Uso

​Testar Regras de Fraude

​Migração de Dados

​Registro Manual de Dispositivo

​Próximos Passos

Listar Dispositivos

API de Eventos

Visão Geral

Endpoint

Autenticação

Parâmetros de Caminho

Corpo da Requisição

Resposta

Exemplos

Exemplo de Resposta

Respostas de Erro

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

Casos de Uso

Testar Regras de Fraude

Migração de Dados

Registro Manual de Dispositivo

Próximos Passos