GlobalSuite® API

Com o uso das APIs, pode integrar o GlobalSuite® com o restante das aplicações, ferramentas ou sistemas do seu ecossistema corporativo. Por exemplo:

• Pode automatizar a importação de ativos de outras ferramentas.

• Sincronizar informações para exportá-las para outra ferramenta para sua gestão.

• Exportar registos para armazená-los em um repositório ou lago de dados (EDL).

Pode consultar a API do GlobalSuite® através do repositório de documentação API GlobalSuite®. Também é possível realizar testes diretamente para verificar as operações que fornece, tanto de leitura, escrita, modificação ou eliminação de dados.

NOTA: Se deseja começar a utilizar as APIs do GlobalSuite®, entre em contato com o seu fornecedor.

Existem ambientes de demonstração que podem ser solicitados para revisar e realizar testes de integração sobre as APIs disponíveis:

Europa:

• URL (documentação API):

  • https://demo-eu.globalsuitesolutions.com/docs

• URL (integração API):

  • https://demo-eu.globalsuitesolutions.com/v1

Latam:

• URL (documentação API):

  • https://demo-la.globalsuitesolutions.com/docs

• URL (integração API):

  • https://demo-la.globalsuitesolutions.com/v1

Habilitar API Key

As APIs do GlobalSuite® são utilizadas de forma segura, prevenindo usos não autorizados das mesmas. Para isso, é necessário criar uma API Key ou token que permita realizar as chamadas de forma autenticada.

Estas API Keys são geradas com uma validade ou vigência concreta (um intervalo de datas) especificado pelo cliente ou integrador. Antes ou depois das datas indicadas, a API Key não será válida, e as chamadas aos endpoints devolverão a seguinte mensagem de erro 403:

Subentidades

Caso tenha habilitado várias Subentidades no GlobalSuite®, será necessário gerar uma API Key específica para cada entidade que se deseje integrar com uma ferramenta ou serviço próprio ou de terceiros.

No GlobalSuite® a configuração é comum a nível de todas as entidades de uma empresa, mas os dados e registos são específicos de cada uma, pelo que se desejar integrar um repositório de informações com alguma seção da ferramenta (por exemplo, Inventário de Elementos) será necessário criar uma API Key para cada entidade, já que os elementos registados com essa API Key serão criados na entidade configurada.

NOTA: Se não houver múltiplas entidades, não será necessário definir várias chaves.

Boas práticas e conselhos

• Certifique-se de utilizar uma única API Key por aplicação ou integração realizada.

• Altere periodicamente a API Key utilizada para maior segurança.

Usar a Documentação de API

Na documentação da API GlobalSuite®, são apresentados os diferentes itens ou modelos que podem ser consumidos de forma automatizada.

Cada um desses recursos é uma representação simbólica de um objeto do domínio de negócio do GlobalSuite®. Por exemplo, um Serviço, um Empregado, etc.

Para cada um dos modelos, é possível consultar os endpoints ou operações GET, PUT, POST e DELETE que estejam permitidas:

Estes endpoints correspondem às operações básicas CRUD (Create, Read, Update and Delete):

• GET: Endpoint para obter um ou vários dos modelos a consultar, podendo realizar filtragens dessas consultas.

• POST: Endpoint para criar um novo registo de um modelo concreto.

• PUT: Endpoint para modificar ou atualizar algum dos valores ou campos do modelo.

• DELETE: Endpoint para eliminar um registo concreto do modelo.

A documentação de cada um desses endpoints inclui os parâmetros, obrigatórios ou opcionais, que podem ser incluídos em cada chamada:

Também, no próprio explorador, são exibidos exemplos de resposta que são fornecidos em cada caso, incluindo as respostas corretas, ou as mensagens de erro, se for o caso.

Utilizar um cliente REST

Para realizar as chamadas à API do GlobalSuite®, é possível utilizar diferentes clientes que realizem as chamadas HTTP ao servidor do GlobalSuite®. É possível realizar tanto chamadas simples, como processos mais complexos utilizando algumas ferramentas como cURL ou Postman.

Rate Limit

Para evitar problemas de desempenho, ou ataques de força bruta do tipo DDoS ou similar, foi implementado um mecanismo de rate limit, que restringe o número de chamadas à API que podem ser realizadas em um período de tempo.

Este limite é geral, pelo que são consideradas o total de chamadas realizadas com a mesma API-Key, mesmo que sejam chamadas a diferentes endpoints ou registos.

Atualmente esse limite é de 180 chamadas em um minuto.

Caso esse limite seja ultrapassado, as chamadas seguintes devolverão a mensagem de erro 429 "Too Many Attempts", para indicar que a taxa limite foi excedida, e será necessário esperar para poder continuar a utilizá-la.

Ajuda: Documentação de Referência

• Antes de utilizar as APIs do GlobalSUITE®, recomendamos familiarizar-se com o Manual de Utilizador GlobalSuite®, já que há uma grande relação entre a lógica de negócio e a API.

• Se tiver alguma dúvida ou possível problema com algum dos endpoints disponíveis na Documentação API GlobalSuite®, pode entrar em contato com o nosso Centro de Suporte a Clientes.

• Use a documentação de API do GlobalSuite® para encontrar referências para a última versão disponível da API REST.

Certificação de segurança GlobalSUITE® (CSWA)

Como parte do ciclo de melhoria contínua nos nossos processos de desenvolvimento utilizados no GlobalSuite®, realizámos uma validação externa através de uma auditoria de segurança de Hacking Ético.

Esta verificação foi realizada de acordo com os padrões OWASP Top Ten 2017 e API Security Top 10 2019, integrando os controlos propostos por ambos os padrões nos nossos processos de verificação e conformidade.

Este processo de auditoria permitiu certificar a segurança e resiliência do GlobalSUITE®, trazendo consigo o certificado CSWA, nos nossos ambientes SaaS e On Premise.

Versionamento de API

Como parte da manutenção e serviço das APIs que o GlobalSuite® oferece, inclui-se a gestão de versões e o controlo de alterações das mesmas.

A API é sempre oferecida na sua versão mais atualizada ( Current) que estará vigente até que seja realizada uma evolução do produto que implique um Breaking Change.

Este breaking change é uma atualização que modifica a estrutura de chamadas e/ou respostas de algum dos endpoints oferecidos.

Caso esta situação ocorra, a versão anterior passará para um estado Deprecated, mas continuará acessível até que ocorra outro breaking change, para que possam ser realizadas adaptações (se necessário) para manter as integrações realizadas.

As atualizações de versões do GlobalSuite® serão notificadas na própria ferramenta após uma atualização e poderão ser consultadas a qualquer momento no Changelog GlobalSuite®

Lista de versões da API GlobalSuite®