Muitas, muitas APIs para todos!

versão 4.10.0.0 Um presente para todos os desenvolvedores e aqueles que querem levar nosso produto ao limite!

Nesse release estamos liberando uma infinidade de novas APIs, voltadas principalmente para a gestão de usuários, times, funções e permissões. Esperamos que elas sejam úteis para sincronizar o sistema com outros softwares repositórios de pessoas, organogramas e permissões!

APIs, ou “Interface de Programação de Aplicações” , são como "pontes" que permitem a conexão, comunicação e integração entre sistemas diferentes. Quando dizemos que estamos lançando novas API's significa que estamos tornando mais informações e serviços do nosso produto disponíveis para integrações.

Novas APIs

Veja abaixo algumas das API's liberadas.

Instâncias

  • Cancelar uma instância em andamento

Formulário

  • Atualizar, administrativamente, os valores de campos de formulário de uma instância em andamento

Times

  • Listar times que o dono do token tem permissão de visualizar
  • Obter time pelo código identificador
  • Listar as funções relacionadas ao time
  • Listar os usuários associados ao time
  • Obter time pelo código padrão

Funções

  • Listar funções que o dono do token tem permissão de visualizar
  • Obter função pelo código identificador

Grupos de permissões

  • Listar todos os grupos de manutenção do sistema
  • Obter grupo de manutenção pelo código identificador
  • Listar as permissões associadas ao grupo
  • Listar os usuários vinculados ao grupo
  • Obter grupo de manutenção pelo código padrão

Usuários

  • Listar usuários do sistema
  • Cadastrar ou atualizar um usuário, com grupos de manutenção, times e funções relacionados
  • Enviar mensagem de boas vindas
  • Obter usuário por código do usuário
  • Excluir um usuário por código do usuário
  • Definir usuário como em ausência temporária por código do usuário
  • Tirar um usuário de ausência temporária por código do usuário
  • Ativar um usuário por código do usuário
  • Desativar um usuário por código do usuário
  • Bloquear o acesso de um usuário ao sistema por código do usuário
  • Desbloquear o acesso de um usuário ao sistema por código do usuário
  • Listar grupos de manutenção por código do usuário
  • Adicionar um grupo de manutenção a um usuário
  • Excluir um grupo de manutenção a um usuário
  • Copia todos os grupos de manutenção de um usuário para outro
  • Forçar usuário a alterar sua senha no próximo login
  • Enviar e-mail para usuário definir nova senha
  • Resetar a senha de um usuário a partir do token de alteração de senha
  • Listar posições e times por código do usuário
  • Adicionar um time e função a um usuário
  • Excluir um time e função de um usuário
  • Copia todos os times e funções de um usuário para outro
  • Transferir a propriedade de dados de um usuário para outro
  • Obter usuário por username do usuário

Lembrando que as APIs do sistema estão todos acessíveis no link abaixo:


Nova API de criar usuários

Com certeza uma das APIs mais solicitadas por nossos clientes é a API de criar um novo usuário do sistema. E agora ela está disponível e pronta para uso. E podemos dizer que ela é muito, muito poderosa!

Vejam algumas coisas que ela pode fazer:

  1. Criar um usuário no sistema

    - Ou atualizar os dados de um usuário no sistema, se o login já existir
    - Ou  retornar um erro controlado, se o login já existir
    - Ou  retornar os dados do usuário existente, se o login já existir

  2. Enviar e-mail ao usuário solicitando que ele crie sua senha de acesso

  3. Adicionar um ou mais grupos de manutenção ao usuário (opciona)

    - Ou substituir os grupos existentes pelos novos grupos recebidos

  4. Adicionar posições e times ao usuário (opciona)

    - Ou substituir as posições e times existentes  pelos novos grupos recebidos 


Novos recursos para APIs

Além das novas APIs disponibilizadas, muitas APIs agora vem com suporte a OData (Open Data Protocol, conheça em https://www.odata.org/ , um protocolo open source que permite manipular os resultados de APIs para que elas retornem dados mais aderentes a sua necessidade.

As APIs que suportam OData, assim como os parâmetros OData suportados, são descritas na própria documentação das APIs. No exemplo abaixo, vemos a documentação do método de "Listar usuários do sistema", onde é descrito explicitamente que ele suporta os parâmetros OData $top, $select, $orderby e $filter. 


  • $top: permite definir, na chamada da API, a quantidade de registros que você deseja retornar;
  • $select: permite definir, na chamada da API, quais atributos do documento JSON de retorno devem ser retornados, limitando assim o volume de registros movimentado;
  • $orderby: permite modificar os critérios de ordenação dos resultados da API;
  • $filter: permite realizar filtros adicionais, não previstos na documentação da API, sobre os resultados da API.

Entre no site https://www.odata.org/ e conheça como utilizar esses parâmetros.


Mudanças em APIs existentes

Veja algumas mudanças em APIs existentes:

POST /api/2/instances/report

Listar todas instâncias de solicitações que o usuário do token possui permissão de consultar de acordo com filtros (Auth)

As mudanças abaixo visam facilitar construir integrações que possam facilmente apontar para ambientes de desenvolvimento, homologação e produção mantendo os mesmos parâmetros de consulta:

  • A API passa a aceitar flowUID, que é o código único de identificação do processo, inclusive entre ambientes diferentes
  • A API passa a aceitar serviceUID, que é o código único de identificação do processo, inclusive entre ambientes diferentes
  • A API passa a permitir filtrar por campos do formulário utilizando o name do campo, que é um identificador textual único do campo, ao invés de usar seu ID, um número auto-gerado