A API permite a criação, consulta e atualização de empresas, garantindo um gerenciamento eficiente e centralizado das informações empresariais dentro da plataforma.

Create Company

Permite a criação de uma nova empresa na plataforma, registrando suas informações e vinculando-a ao sistema.

📌Endpoint

  • Método: POST
  • Endpoint: /companies

Após a criação, a empresa será identificada por um ID único, que poderá ser utilizado para futuras consultas e atualizações.

Find Companies

Realiza a busca de empresas cadastradas com base em critérios de pesquisa, permitindo a localização eficiente de registros na plataforma.

📌Endpoint

  • Método: GET
  • Endpoint: /companies

Os filtros de pesquisa podem incluir diferentes parâmetros, possibilitando a listagem segmentada de empresas conforme a necessidade do cliente.

Get Company

Retorna os detalhes completos de uma empresa cadastrada, incluindo suas informações gerais e dados associados.

📌Endpoint

  • Método: GET
  • Endpoint: /companies/{id}

Para obter os dados, é necessário informar o ID da empresa, que pode ser obtido no momento da criação ou por meio da busca de empresas.

Update Company

Permite a atualização dos dados de uma empresa previamente cadastrada, possibilitando ajustes e alterações conforme necessário.

📌Endpoint

  • Método: PUT
  • Endpoint: /companies/{id}

O ID da empresa deve ser informado para que as alterações sejam aplicadas corretamente. Apenas os campos permitidos poderão ser modificados, garantindo a integridade dos dados.