API v0.

Host: ​[Link]
API URI: /webapi/v1
Ex:​ ​[Link]

As requisições requerem um token de autenticação que pode ser gerado a partir do

menu API no CRM.

Parâmetros marcados com ​*​ são obrigatórios.

Respostas HTTP:

● 200 - A requisição completou com sucesso e retornou dados.

● 204 - A requisição completou com sucesso porém nenhum dado foi
encontrado.
● 400 - Parâmetro(s) inválido(s)
● 401 - Token inválido ou desativado
● 500 - Erro interno no servidor.

1
Listar câmeras

Retorna um JSON com a lista de câmeras da plataforma.

URL: /cameras
Método: GET
Parâmetros:
*​token:​ Token de autenticação.

Exemplo:
[Link]

2
Pegar Dados de câmera específica

Retorna os dados da câmera filtrada pelo id.

URL: /cameras/{{id}}
Método: GET
Parâmetros:
*​token:​ Token de autenticação.
*​id:​ Id da câmera.

Exemplo:
[Link]

3
Gerar dashboard dinâmico

Retorna o html de um dashboard dinâmico

URL: /dashboard
Método: GET
Parâmetros:
*​token:​ Token de autenticação.
*​idList:​ Lista de id das câmeras.
hideVIP:​ Por padrão as câmeras VIP são escondidas, passe “false” neste
para mostrá-las.
time:​ Abre os vídeos a partir do tempo informado. Aceita qualquer formato de
data aceito pelo objeto Date do javascript.

Exemplo:
[Link]
en=123456

4
Gerar dashboard dinâmico com dados do MONI

​Retorna o html de um dashboard dinâmico ou JSON com os metadados

utilizando os campos do Moni, campos disponíveis: empresa, central, particao,
auxiliar.

​ URL: /dashboard/moni
Método: GET
Parâmetros da URL:
*​ token​ – Token de autenticação.
*​fieldsList​ – Lista de campos do moni, é necessário ao menos um campo do
sigma para localizar as câmeras.
hideVIP​ – Por padrão as câmeras VIP são escondidas, passe “false” neste
parâmetro para mostrá-las.
time​ - Abre os vídeos a partir do tempo informado. Aceita qualquer formato
de data aceito pelo objeto Date do javascript.
onlymetadata​ - O endpoint retorna um JSON ao invés do HTML para embed.
Aceita apenas “true”. Se o parâmetro time for usado junto do onlymetadata o
time é ignorado.

Exemplo:
[Link]
&fieldsList[0][auxiliar]=A1&fieldsList[0][empresa]=E1&fieldsList[0][particao]=P1&field
sList[1][empresa]=E2&hideVIP=false&token=123&onlymetadata=true

5
Gerar Dashboard dinâmico com dados do Sigma

Retorna o html de um dashboard dinâmico utilizando os campos do Sigma

URL: /dashboard/sigma
Método: GET
Parâmetros:
*​token:​ Token de autenticação.
*​fieldsList:​ Lista de campos do sigma (mínimo: 1). Valores possíveis:
idCentral,auxiliar,empresa,particao.
hideVIP:​ Por padrão as câmeras VIP são escondidas, passe “false” neste
para mostrá-las.
time:​ Abre os vídeos a partir do tempo informado. Aceita qualquer formato de
data aceito pelo objeto Date do javascript.

Exemplo:
[Link]
1&fieldsList[0][auxiliar]=A1&fieldsList[0][empresa]=E1&fieldsList[0][particao]=P1&fiel
dsList[0][empresa]=E2&hideVIP=false&token=123

6
Retornar dados de grupos

Retorna um array de JSON com as informações de grupos

URL: /groups
Método: GET
Parâmetros:
*​token:​ Token de autenticação.
*​idList[]:​ Lista de id de grupos (mínimo: 1).

Exemplo:

[Link]

7
Retornar dados de grupos com parâmetros do Sigma.

Retorna um array de JSON com as informações de grupos utilizando os dados do

Sigma das câmeras ligadas ao grupo.

URL: /groups/sigma
Método: GET
Parâmetros:
*​token:​ Token de autenticação.
*​fieldsList:​ Lista de campos do sigma (mínimo: 1). Valores possíveis:
idCentral, auxiliar, empresa, particao.

Exemplo:

[Link]
t[0][auxiliar]=A1&fieldsList[0][empresa]=E1&fieldsList[0][particao]=P1&fieldsList[0][e
mpresa]=E2&token=123

8
Inserir dados de compras no shop

Retorna um array de JSON com as informações do item que foi inserido.

URL: /shop/purchase
Método: POST
Parâmetros:
*​token:​ Token de autenticação. (Passado na URL, por GET)
*​email: ​E-mail do comprador
*​planId: ​Identificador do Plano da câmera conforme de planos na aba
CRM->Loja->Planos e preços
installments: ​Número de parcelas (Padrão 1)
quantity: ​Quantia de câmeras (Padrão 0)
planQuantity: ​Quantia de planos (Padrão 0)
productId: ​Identificador do produto (Padrão 1, No momento só existe a
câmera P2P, ID: 1)

Exemplo:

[Link]

Body:

{
"email":"joao@[Link]",
"installments":"1",
"quantity":"1",
"planQuantity":"1",
"planId":"1"
}

9
Gravar vídeo rápido

Retorna a URL de um print e de um vídeo com 1 minuto de duração ( 30s + / - )

baseado no tempo passado.

URL: /createQuickRecord/:id
Método: GET
Parâmetros:
*​id:​ Token de autenticação.
*​token:​ Token de autenticação.
*​time:​ Token de autenticação.
*​postback_url: ​Url que receberá a chamada POST de retorno com os dados
do pedido no formato:
POST postback_url
{
"success": boolean,
"shot": string,
"video": string
}

timeout: 10000
onlyshot:​ Não gera video, apenas imagem. ( Padrão false )
shotres:​ Resolução da imagem. NxN ( Padrão 200x100 )

Exemplo:

[Link]
time=1504694559739&onlyshot=false&shotres=200x100&token=X&postback_url=​htt
p://[Link]/quick_record_postback_url

10
Métodos para chave de usuário

Listagem de câmeras

Retorna um JSON com a lista de câmeras que o usuário dono da

chave pode visualizar.

URL: user/cameras
Método: GET
Parâmetros da URL:
*​token​ – Token de autenticação

Exemplo:
[Link]

11
Dados de câmera específica

Retorna os dados da câmera filtrada pelo id.

URL: user/cameras/{{id}}
Método: GET
Parâmetros da URL:
*​token​ - Token de autenticação
*​id​ - Id da câmera

Exemplo:
[Link]

12