Skip to content

Empresa Api (v1.0.0)

API de Gestão de Empresas

A API de Gestão de Empresas da RGBtec foi desenvolvida para proporcionar controle total sobre as informações das empresas cadastradas e suas respectivas configurações de integração dentro do sistema. Com ela, você pode gerenciar o ciclo de vida das empresas, desde o cadastro até a alteração, e também administrar as integrações que as conectam a outros sistemas.

Simplificando a administração e a conectividade das empresas com o poder e a flexibilidade de uma API de alta performance!

A seguir, detalhamos as principais funcionalidades oferecidas por cada um dos endpoints.

Download OpenAPI description
v1.json
v1.yaml
Overview
rgbtec
support@rgbtec.com.br
Languages
Servers
Mock server
https://apidocs.ger26.com.br/_mock/apis/empresas/v1/
http://rgbsys.dyndns.info/ger2025-empresa-api-desenvolvimento/

Empresas

Este conjunto de recursos permite a manipulação e consulta de dados de empresas no sistema:

  • Listar Empresas:
    • Obtenha uma lista completa de todas as empresas registradas.
    • Consulte empresas ativas com opções de filtragem por nome, paginação e quantidade de registros.
  • Consultar Empresa por ID:
    • Recupere os detalhes de uma empresa específica utilizando seu identificador único.
  • Cadastrar Empresa:
    • Crie novos registros de empresas no sistema.
  • Alterar Empresa:
    • Atualize as informações de uma empresa existente.
Operations

Integrações

Estes recursos são dedicados ao gerenciamento das configurações de integração vinculadas a cada empresa:

  • Listar Integrações:
    • Visualize todas as integrações configuradas para uma empresa específica.
  • Consultar Integração por ID:
    • Obtenha os detalhes de uma integração específica, fornecendo o ID da empresa e o ID da integração.
  • Alterar Integração:
    • Modifique as configurações de uma integração existente para uma determinada empresa.
  • Desativar Integração:
    • Desabilite uma integração específica de forma segura.
Operations

Desativar integração

Request

Desativa uma integração da empresa

Path
empresaIdstringrequired

Id da empresa

empresaIntegracaoIdstringrequired

Id da empresa integração

curl -i -X PATCH \
  'https://apidocs.ger26.com.br/_mock/apis/empresas/v1/api/v1/empresas/{empresaId}/integracoes/{empresaIntegracaoId}/desativar'

Responses

OK

Response
No content

Alterar integração

Request

Altera uma integração da empresa

Path
empresaIdstringrequired

Id da empresa

integracaoIdstringrequired

Id da integração da empresa

Body
required
ativobooleanrequired

Indica se a integração está ativa ou não

configuracoesArray of objects or null(AlterarConfiguracoes)required

Array de configurações

configuracoes[].​idstring or nullrequired

Id da configuração

configuracoes[].​valorstring or nullrequired

Valor da configuração

curl -i -X PUT \
  'https://apidocs.ger26.com.br/_mock/apis/empresas/v1/api/v1/empresas/{empresaId}/integracoes/{integracaoId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "ativo": true,
    "configuracoes": [
      {
        "id": "string",
        "valor": "string"
      }
    ]
  }'

Responses

OK

Response
No content

Recuperar integração por id

Request

Recupera uma integração da empresa pelo id

Path
empresaIdstringrequired

Id da empresa

integracaoIdstringrequired

Id da integração

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/empresas/v1/api/v1/empresas/{empresaId}/integracoes/{integracaoId}'

Responses

OK

Bodyapplication/json
idstring or nullrequired

Id da integração

nomestring or nullrequired

Nome da integração

descricaostring or nullrequired

Descrição da integração

instrucoesAdicionaisstring or nullrequired

Texto indicando os passos que devem ser feitos para o funcionamento da integração

configuracoesArray of objects or null(ConfiguracaoResponse)required

Configurações da Integração

configuracoes[].​idstring or nullrequired

Id único da entidade

configuracoes[].​idIntegracaoConfiguracaostring or nullrequired

Id único da entidade GeralIntegracaoConfiguracao

configuracoes[].​nomestring or nullrequired

Nome da configuração

configuracoes[].​descricaostring or nullrequired

Descrição da configuração

configuracoes[].​valorstring or nullrequired

Valor da configuração

configuracoes[].​tipointeger(TipoDadoConfiguracaoEnum)required

Tipo da configuração

configuracoes[].​obrigatoriobooleanrequired

Indica se é obrigatório ou nao

ativobooleanrequired

Indica se a integração está ativo ou não

imagemstring or null

Id da imagem que representa a integração (opcional)

Default null
Response
application/json
{
  "id": "string",
  "nome": "string",
  "descricao": "string",
  "instrucoesAdicionais": "string",
  "configuracoes": [
    { … }
  ],
  "ativo": true,
  "imagem": null
}

Listar integrações

Request

Lista todas as integrações disponíveis para a empresa

Path
empresaIdstringrequired

Id da empresa

curl -i -X GET \
  'https://apidocs.ger26.com.br/_mock/apis/empresas/v1/api/v1/empresas/{empresaId}/integracoes'

Responses

OK

Bodyapplication/jsonArray [
idstring or nullrequired

Id da integração

empresaIntegracaoIdstring or nullrequired

Id da empresa integração

nomestring or nullrequired

Nome da integração

ativobooleanrequired

Determina se a integração está ativa para a empresa

descricaostring or nullrequired

Descrição da integração

imagemstring or null

Id da imagem que representa a integração

Default null
]
Response
application/json
[
  {
    "id": "string",
    "empresaIntegracaoId": "string",
    "nome": "string",
    "ativo": true,
    "descricao": "string",
    "imagem": null
  }
]