Abertura Remota Porta e Catraca

Para abrir remotamente uma porta, ou permitir o giro de uma catraca, será necessário utilizar o endpoint descrito abaixo "execute actions".

Executar ação

Executa uma ação no equipamento. O método HTTP usado é o POST. Verificar no exemplo no fim desta página como usá-lo.

POST /execute_actions.fcgi

Parâmetros

• actions (array de objetos JSON) : Cada elemento deste array possui 2 chaves, ambas strings: action e parameters. action é uma ação a ser executada e parameters são os parâmetros dessa ação.

  • action (string) : Ação a ser executada, as ações disponíveis são:

    • door : Ação para abrir portas.
    • sec_box : Ação para abrir portas em dispositivos que utilizam o modulo de acionamento externo (SecBox).
    • open_collector : Ação para abrir o coletor (urna) da catraca iDBlock.
    • catra : Ação para liberar a catraca para um dos lados ou ambos.

  • parameters (string) : Parâmetros das ações acima, maiores detalhes nos exemplos abaixo.

Resposta

• Esta chamada não possui retorno.

Exemplo Abrir Relé iDAccess/iDFit/iDBox/iDUHF:

$.ajax({
    url: "/execute_actions.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        actions: [ { action: "door", parameters: "door=1" } ]
    })
});

Exemplo Abrir Relé iDFlex/iDAccess Pro/iDAccess Nano/iDUHF:

$.ajax({
    url: "/execute_actions.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        actions: [ { action: "sec_box", parameters: "id=65793, reason=3" } ]
    })
});

Exemplo Abrir Coletor (urna) Catraca

Abre o coletor (urna) da iDBlock, não recebe nenhum parâmetro:

$.ajax({
    url: "/execute_actions.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        actions: [ { action: "open_collector", parameters: "" } ]
    })
});

Libera a catraca para um lado

Esta ação recebe um parâmetro (allow="direction"), onde "direction" deve ser "anticlockwise", "clockwise" ou "both". A catraca será liberada para o sentido anti-horário, horário ou ambos respectivamente. O exemplo abaixo libera a catraca para o sentido horário:

$.ajax({
    url: "/execute_actions.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        actions: [ { action: "catra", parameters: "allow=clockwise" } ]
    })
});

Ativa os relés da catraca

Esta ação recebe um parâmetro "relay", que deve ser igual à "1" ou "2".

$.ajax({
    url: "/execute_actions.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        actions: [ { action: "catra", parameters: "relay=1" } ]
    })
});

Verificar o estado das portas do equipamento (aberta / fechada)

Obtém o estado das portas do equipamento (aberta / fechada). O método HTTP usado é o POST.

POST /door_state.fcgi

Parâmetros

• Esta chamada não possui parâmetros.

Exemplo de Respostas:

Dispositivos com SecBox conectados:

"sec_boxes": [
                {
                    "id": 122641794705017745,
                    "open": false
                },
                {
                    "id": 65793,
                    "open": false
                }
             ]

Dispositivos com relés conectados:

"doors": [
            {
                "id": 1,
                "open": false
            },
            {
                "id": 2,
                "open": false
            }
         ]

Dispositivo sem relé conectado:

"error" : "Sec Box count message parameter is invalid",
"code" : 1

Exemplo de requisição

$.ajax({
    url: "/doors_state.fcgi?session=" + session,
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({})
});