> For the complete documentation index, see [llms.txt](https://portal-integracao.intelbras.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portal-integracao.intelbras.com.br/defense-ia-and-lite/readme/controle-de-acesso.md). # Controle de acesso Guia de endpoints de Controle de Acesso (OBMS/ACP): trancar/destrancar portas, status global de área, regras excluídas e consultas de pontos de acesso/portas, com exemplos curl. ### Como usar: * Substitua variáveis `{{host}}`, `{{loginToken}}`, pelos valores reais do seu ambiente ou utilize variáveis que tenham esses valores. * Copie e cole os blocos por endpoint e mantenha a estrutura “Tópico / Fonte / Resposta / Exemplo”. * Adicione/oculte campos de corpo (JSON) conforme a necessidade do seu caso, mantendo o padrão do projeto. *** ### Convenções e autenticação * Códigos de resultado (padrão): `code: 1000` indica sucesso * Content-Type: `application/json;charset=UTF-8` * Idioma (opcional): `Accept-Language: en` * Autenticação: header `X-Subject-Token: {{loginToken}}` (obtenha o token no seu fluxo de login do projeto) * Base URL: `http://{{host}}/brms/api/v1.1` *** ### Erros comuns (modelo):
SituaçãoSintomaComo resolver
Token ausente/expirado401Refaça login e atualize X-Subject-Token
Content-Type incorreto415 Unsupported Media TypeUse application/json;charset=UTF-8
Campos obrigatórios vazios400 / mensagem de validaçãoRevise a seção Parâmetros do endpoint
*** ### Trancar e destrancar uma única porta **Tópico**: Permite **trancar ou destrancar uma porta específica** por meio do sistema de controle de acesso. * Método: `POST /obms/api/v1.0/accessControl/door/control` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{[Host}}/obms/api/v1.0/accessControl/door/control' --header 'X-Subject-Token: 72F863A39D1347E4b2ffb19fea0c467f' --header 'Content-Type: application/json' --header 'Cookie: Path=/' --data '{ "status": "1", "channelId": "1000001$7$0$0" }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Configurar status global **Tópico**: Permite **configurar o status global de uma área** no sistema de controle de acesso, alterando o estado geral de funcionamento conforme o valor informado. * Método: `POST /obms/api/v1.1/acp/area/001/global/status` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location --request PUT 'https://{{Host}}/obms/api/v1.1/acp/area/001/global/status' --header 'X-Subject-Token: 81B555C0DA3440ECab1d2f372796352e' --header 'Content-Type: application/json' --header 'Cookie: Path=/' --data '{ "globalStatus": "2" }' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": null } ``` ### Obter lista de regras de acesso que não foram configuradas para recursos **Tópico**: Permite **assinar (subscribe)** o recebimento de alarmes enviados pelo sistema, configurando uma **URL de callback** para receber notificações em tempo real sempre que um alarme for disparado. * Método: `POST /obms/api/v1.1/acp/area/001/global/status` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/obms/api/v1.1/acp/passage/rule/exclude/page?page=1&pageSize=20&resourceType=4&resourceCode=67312393&keyword=' --header 'X-Subject-Token: 81B555C0DA3440ECab1d2f372796352e' --header 'Cookie: Path=/' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "pageData": [ { "id": "1", "ruleName": "CEO", "ruleType": "1", "pointType": "1", "timeTemplateId": "1", "timeTemplateName": "time.template.name.all", "holidayPlanId": "", "holidayPlanName": null, "personCount": 1, "pointCount": 3 } ], ``` ### Obter lista de regras de acesso que não foram configuradas para uso **Tópico**: Permite **consultar a lista de regras de acesso que ainda não foram associadas a um recurso específico**, possibilitando a vinculação posterior dessas regras no sistema de controle de acesso. * Método: `POST /obms/api/v1.1/acp/area/001/global/status` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/obms/api/v1.1/acp/passage/rule/exclude/page?page=1&pageSize=20&resourceType=4&resourceCode=67312393&keyword=' --header 'X-Subject-Token: 81B555C0DA3440ECab1d2f372796352e' --header 'Cookie: Path=/' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "pageData": [ { "id": "1", "ruleName": "CEO", "ruleType": "1", "pointType": "1", "timeTemplateId": "1", "timeTemplateName": "time.template.name.all", "holidayPlanId": "", "holidayPlanName": null, "personCount": 1, "pointCount": 3 } ], ``` ### Obter a lista paginada de pontos de acesso associados à área de controle de acesso informada. **Tópico**: Permite **consultar a lista de regras de acesso que ainda não foram associadas a um recurso específico**, possibilitando a vinculação posterior dessas regras no sistema de controle de acesso. * Método: `POST /obms/api/v1.1/acp/area/001/point/page?page` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/obms/api/v1.1/acp/area/001/point/page?page=1&pageSize=100&containChild=&boundary=&pointTypes=&pointName=&excludeRuleType=&includeRuleType=&ruleId=&sourceTypes=&supportHoliday=1' --header 'X-Subject-Token: 81B555C0DA3440ECab1d2f372796352e' --header 'Cookie: Path=/; Path=/' ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "totalCount": "3", "pageData": [ { "id": "11", "areaCode": "001", "areaName": "Site", "areaPath": "Site", "pointName": "SS 5530 MF FACE_Door1", "pointType": "1", "remark": null, "mapId": "", "gpsX": null, "gpsY": null, "boundary": "0", "globalStatus": "2", "sourceType": "1", "sourceId": "", "associateId": "", "relateObjects": [ { "objectType": "1", "objectCode": "1000030$7$0$0", "objectName": "Door1", "readers": null } ``` ### Obter o status de acesso do ponto de controle. **Tópico**: Permite **consultar o status de acesso de um ou mais pontos de controle (portas)** no sistema de controle de acesso, com base nos identificadores informados. * Método: `POST /obms/api/v1.1/acp/area/001/point/page?page` * Headers: `X-Subject-Token`-Token de autenticação * `Content-Type`: `application/json` Exemplo (curl): ```powershell curl --location 'https://{{Host}}/obms/api/v1.1/acp/point/door/status' --header 'X-Subject-Token: B5403CBC81C344BF9989977b603a5128' --header 'Content-Type: application/json' --data '{ "pointIds": [ "2" ] } ``` Resposta (modelo – sucesso): ```json { "code": 1000, "desc": "Success", "data": { "totalCount": "3", "pageData": [ { "id": "11", "areaCode": "001", "areaName": "Site", "areaPath": "Site", "pointName": "SS 5530 MF FACE_Door1", "pointType": "1", "remark": null, "mapId": "", "gpsX": null, "gpsY": null, "boundary": "0", "globalStatus": "2", "sourceType": "1", "sourceId": "", "associateId": "", "relateObjects": [ { "objectType": "1", "objectCode": "1000030$7$0$0", "objectName": "Door1", "readers": null } ``` *** Notas finais: * Todas as requisições exigem autenticação via header `X-Subject-Token`, obtido no fluxo de login do sistema. * O código `code: 1000` indica sucesso nas operações. * Os endpoints pertencem a módulos diferentes (BRMS e OBMS/ACP); verifique sempre a Base URL correta. * Campos do corpo (JSON) podem ser ajustados conforme a necessidade do projeto, mantendo o padrão definido. * Algumas operações exigem permissões administrativas. * Confirme a versão correta da API (`v1.0` ou `v1.1`) antes de consumir os endpoints. *** --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://portal-integracao.intelbras.com.br/defense-ia-and-lite/readme/controle-de-acesso.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.