Integração Control ID Preddita

Endpoints e referencia para integração de dispositivos Control ID

• Visão geral da API Control ID

  • Uma api para adicionar novos usuários para as controladoras cadastradas assim como configuração para o envio de informações sobre sua abertura.

• Propósito e funcionalidades principais

  • Listar equipamentos cadastrados

  • Adicionar um Usuário a uma controladora específica

  • Adicionar Endereço de Webhook para recepção de aberturas de porta

Listar Dispositivos

GET cadastro.preddita.com.br/faceid/device/list

Headers

Name	Value
Content-Type	application/json
Authorization	Token <token>

Body

Name	Type	Description	Required
tenant_token	String	Identificador do Empreendimento

tenant_token é disponibilizado pela Preddita

Response

200

{
  "count": 1,
  "total_pages": 1,
  "current_page": 1,
  "results": [
    {
      "device_id": "00000000000",
      "device_name": "NOME_DISPOSITIVO",
      "device_model": ""
    }
  ]
}

Adicionar Novo usuário a uma Controladora

POST cadastro.preddita.com.br/faceid/user/new

Headers

Name	Value
Content-Type	application/json
Authorization	Token <token>

Body

Name	Type	Description	Required
tenant_token	String	Identificador do Empreendimento
device_id	String	Identificador do Equipamento
name	String	Nome do Cliente
external_id	String	Identificador Externo
image_data	String Base64	Imagem decodificada em String Base64
image_url	String	Url da imagem

Response

201

{
  "success": true,
  "user_id": 1,
  "external_id": "77777",
  "device_id": "0000000",
  "tenant_token": "AAAXXXXAAA"
}

400

400

Atualiza Usuário em uma Controladora

POST cadastro.preddita.com.br/faceid/user/update

Headers

Name	Value
Content-Type	application/json
Authorization	Token <token>

Body

Name	Type	Description	Required
tenant_token	String	Identificador do Empreendimento
device_id	String	Identificador do Equipamento
name	String	Nome do Cliente
external_id	String	Identificador Externo
image_data	String Base64	Imagem decodificada em String Base64
image_url	String	Url da Imagem

Response

201

{
  "success": true,
  "user_id": 1,
  "external_id": "77777",
  "device_id": "0000000",
  "tenant_token": "AAAXXXXAAA"
}

Adicionar Webhook para Dispositivo

POST cadastro.preddita.com.br/faceid/device/add_webhook

Adiciona um Webhook para envio de informações de abertura do dispositivo. Request enviada para o Webhook

curl --request POST
--url webhook_url
--header 'Content-Type: application/json'
--data '{ device_id : "", user_external_id : "", timestamp : "", }'

Name	Description
device_id	Identificador do Equipamento
user_external_id	Identificador do Usuario
timestamp	Timestamp da ação

Headers

Name	Value
Content-Type	application/json
Authorization	Token <token>

Body

Name	Type	Description	Required
tenant_token	String	Identificador do Empreendimento
device_id	String	Identificador do Equipamento
webhook_url	String	Url do Webhook

Response

201

{
  "success": true
}

Payload a ser enviado para o