Proposta de valor

A "Evolução da API de Agenda do Legal One" oferece aos escritórios uma ferramenta robusta para otimizar a gestão de prazos e tarefas. Ao permitir a criação, alteração e exclusão de compromissos via API, a solução garante maior agilidade na aquisição de novas carteiras, minimiza erros e inconsistências, e eleva a produtividade. Com a nova funcionalidade de "Administração de Clientes API", o valor é ampliado: agora, usuários administradores têm a possibilidade de gerenciar suas próprias integrações com a API do Legal One, independentemente do contexto disponibilizado.

Maior flexibilidade para os nossos clientes, diminuindo a dependência do contato para o time de suporte para ajustes simples nos endpoints da API e a capacidade de manter suas automações e fluxos de trabalho sempre atualizados com controle e segurança.

Objetivo

O objetivo principal desta evolução é personalizar a gestão de tarefas e compromissos, permitindo operações de criação, alteração e exclusão de compromissos e tarefas e subresources através da API, garantindo integridade dos dados e eficiência operacional.

Além disso, a evolução no comportamento da integração da API do Legal One visa permitir que usuários administradores, possam acessar e gerenciar a "Administração de clientes API" diretamente nas configurações do sistema, eliminando a necessidade de intervenção do suporte.

Como configurar

Home -> Configurações -> Configurações gerais- Gerenciar integrações -> Administração de clientes API -> Novo cliente/Alterar cliente da API

A configuração da API de Agenda envolve a habilitação de checkboxes para permitir a escrita e leitura de escopos disponibilizados na API do Legal One, bem como os subresources e endpoints disponibilizados. A novidade é a forma como o acesso à "Administração de Clientes API" é gerenciado, permitindo que administradores realizem essa gestão.

1. Acesso à Administração de Clientes API:

• Para contas Premium: A opção "Administração de clientes API" será exibida por padrão para usuários administradores.
• Para contas Advanced: A opção "Administração de clientes API" será exibida para usuários administradores SOMENTE se o Addon da API REST do Legal One estiver ativo na conta.
• Para contas Starter: Esta opção não será exibida.

2. Configuração da API:

3. No contexto ou módulo listado nas configurações da API, ao habilitar a opção de escrita, o sistema irá permitir inclusão, alteração e exclusão de registros por esse contexto específico via API.

4. Nas opções filhas do contexto como por exemplo "envolvidos", "campos personalizados" e "Vínculos", ao habilitar a opção de escrita correspondente a cada campo, para inclusão/exclusão de destes registros no contexto selecionado via API.

5. No contexto ou módulo listado nas configurações da API, ao habilitar a opção de leitura o sistema irá permitir a busca de registros por esse contexto específico via API.

6. Nas opções filhas do contexto como por exemplo "envolvidos", "campos personalizados" e "Vínculos", ao habilitar a opção de escrita correspondente a cada campo, para inclusão/exclusão de destes registros no contexto selecionado via API.

7. Alterações no cadastro e alteração de clientes da API e nos endpoints específicos de escrita e leitura serão registrados na auditoria do sistema.

Local:

Home > Opções > Configurações > Configurações gerais > Gerenciar integrações > Administração de clientes API > Novo cliente/Alterar cliente da API

8. Exemplo Prático: 

• Um administrador de uma conta Premium (ou Advanced com o Addon ativo) pode utilizar um cliente API para integrar o Legal One com um sistema de criação de registros.
  • Em vez de contatas ao suporteo usuário administrador da conta pode acessar a configuração da integração, clica em "Administração de clientes API", e pode configurar o cliente API, definir suas permissões e endpoints para envio, leitura e escrita de informações.

Novos Endpoints disponibilizados:

• Alteração de Compromissos e Tarefas: por meio do método PATCH nos endpoints de tarefas e compromissos para alterar atividades.
• Obtenção de Informações gerenciamento de tarefas do tipo etapas via API (cadastro, alteração e deleção via GET, POST, PATCH, DELETE
  •  Endpoints específicos para alteração e deleção de envolvidos em compromissos e tarefas. 

Regras e restrições

• As operações requerem a integração da API e credenciais de acesso com permissões específicas para cada escopo de ação dentro da API.·
• As validações relacionadas com adição, alteração de registros relacionados a compromissos e tarefas seguem as regras de negócio existentes no Legal One para cadastro, alteração e exclusão de registros do módulo Agenda.
• Alteração ou adição de envolvidos, campos personalizados e vínculos deverão ser feitos nos seus endpoints específicos caso o compromisso ou tarefa esteja cadastrado anteriormente.
• Etapas:
  • Tarefas do tipo etapas poderão ser criadas via método POST do compromisso ou tarefa principal
  • Alteração e deleção de tarefas do tipo etapas deverão ser via PATCH e DELETE do endpoint de tarefas.

• Contagem de prazos: 
  • Não serão considerados cálculos automáticos de contagem de prazos de registros criados ou alterados via API.
• Recorrência: 
  • No primeiro momento, não será possível configurar recorrência em cadastro/alterações de atividades via API.
  • Não poderão ser alteradas compromissos ou tarefas recorrentes.
  • Caso o compromisso ou tarefa for recorrente, se iniciar uma deleção via API o mesmo ira sair da serie da recorrência e será deletado apenas o ID do compromisso/tarefa informado.
• Lembretes:
  • No primeiro momento, não será possível configurar ou alterar lembretes em cadastro/alterações de atividades via API.
• Workflow:
  • Não poderão ser alteradas tarefas oriundas do Workflow.
  • Não poderão ser excluídas tarefas oriundas do Workflow via API.
• Acesso a "Administração de clientes API":
  • Disponível apenas para contas Premium e Advanced com o Addon ativo.
  • Requer permissões de administrador para acesso às configurações de integração.
  • Contas Starter inicialmente não terão acesso a esta integração.
  • O Addon da API do Legal One deverá estar cadastrado no Winsip e vinculado ao tenant da conta.
  • Para novas contas Advanced, o Addon vira inativo por padrão e precisará ser ativado após contratação.
  • Para novas contas Premium, o Addon virá ativo por padrão.
• Auditoria: 
  • Todas as criações e alterações nos clientes API serão registradas na auditoria do sistema, incluindo o usuário que realizou a ação e a data/hora.
• Mensagem de alerta:
  • No formulário de criação/alteração de clientes API, será exibido um alerta persistente informando que "As informações compartilhadas pela API serão configuradas apenas por usuários autorizados. Para consultar a documentação sobre a API do Legal One clique aqui", com um link para a documentação da API. Conforme imagem abaixo:

• Restrição de escopo: 
  • Esta atualização não altera o comportamento de criação e alteração do cliente API em si; apenas habilita o acesso desta integração aos usuários administradores.

PRODUTOS - BRASIL