O ProjectCanvas permite a integração via API Rest, de modo que as informações possam ser consultadas de modo automatizado em outras ferramentas, trazendo ainda mais possibilidades.
Para essa integração acontecer o usuário "Administrador" deve criar um novo usuário para este fim, deve-se acessar o seguinte link:
Menu >> Gestão de Usuários.
Menu Esquerdo
Logo depois deve-se clicar no botão "+" (Novo Usuário) e preencher o formulário marcando a opção "Integrador API".
Formulário de Cadastro de Usuário
Feito isso, podemos acessar o link da documentação da API para realizar a integrações:
https://app.projectcanvas.online/api-docs
A documentação é baseada na ferramenta Swagger, onde é exibido as API's que estão disponíveis e fornece a possibilidade de testar as API's diretamente nesta página.
A primeira coisa é selecionar qual o ambiente faremos nosso teste de integração, no combo de seleção chamado "Servers":
Depois é necessário chamar a API "/api/v1/users/authenticate" e realizar o login com os dados de e-mail e senha do usuário "integrador" que acabamos de criar, clicando no botão "Execute".
Após chamar a API de Autenticação receberemos um token.
Este token deve ser fornecido clicando no botão "Authorize", dessa forma o token será informado no header de cada requisição feita para consumo das informações.
Realizando os passos acima será possível ter uma base de entendimento de como as API's funcionam e assim realizar a criação de scripts em linguagens de programação que integrem com as API's.
Pontos de atenção:
- Um usuário do tipo integrador só realiza login via API;
- Este recurso é somente para clientes do plano Corporativo;