API e Documentação

O Woulz disponibiliza uma API REST e GraphQL, permitindo integrar o sistema com aplicações externas, automatizar processos e desenvolver integrações personalizadas.

Um dos grandes diferenciais da API é que ela acompanha automaticamente a estrutura do seu CRM. Sempre que um novo módulo ou campo personalizado for criado, ele será disponibilizado automaticamente nas documentações REST e GraphQL, podendo ser utilizado imediatamente em suas integrações, sem necessidade de configurações adicionais.

Gerando uma chave de API

Para acessar a documentação e realizar requisições, é necessário criar uma chave de autenticação.

Siga os passos abaixo:

1. Acesse Configurações.

2. Clique em API e Webhooks.

3. Selecione a opção para criar uma nova Chave de API.

4. Informe um nome para identificar a chave.

5. Defina a data de expiração, caso desejado.

6. Clique em Salvar.

Após a criação, a chave estará disponível para utilização.

Acessando a documentação

Com a chave criada:

1. Copie a chave de API.

2. Retorne à tela API e Webhooks.

3. Cole a chave no campo de autenticação da documentação.

4. Clique em Lançar.

A documentação será aberta já autenticada, permitindo visualizar e testar todas as requisições disponíveis diretamente pelo navegador.

Documentação dinâmica

As documentações REST e GraphQL são geradas de forma dinâmica, refletindo exatamente a estrutura do seu ambiente no Woulz.

Isso significa que:

      -Todo novo módulo criado será automaticamente disponibilizado nas APIs;

      -Todo novo campo personalizado também será automaticamente incluído;

      -Não é necessário atualizar a documentação ou realizar configurações extras para utilizar esses novos recursos.

Dessa forma, qualquer personalização realizada no CRM passa a estar imediatamente disponível para desenvolvimento de integrações.

Benefícios da API

Com as APIs REST e GraphQL do Woulz, é possível:

      -Integrar o CRM com sistemas externos;

      -Automatizar processos e cadastros;

      -Consultar, criar, atualizar e remover registros;

      -Desenvolver integrações sob medida para sua empresa;

      -Trabalhar com módulos e campos personalizados de forma automática;

      -Escolher entre REST ou GraphQL, de acordo com a necessidade de cada integração.

A documentação interativa permite testar requisições em tempo real, tornando o desenvolvimento mais rápido e garantindo que qualquer personalização realizada no Woulz esteja imediatamente disponível para utilização nas APIs.