1. O que é API?
2. Como gerar chaves para a API?
3. Como gerar o Token?
3.1. A API possui limite de requisições e regras de segurança?
4. Documentação de API
5. Exemplos de integração.
FAQ
a - Existem limitações de requisição para API?
A API do Artia possui controle de segurança com limite de 100 requisições por minuto por IP.
Caso esse limite seja ultrapassado, o IP poderá ser bloqueado automaticamente por 1 hora.
Recomendamos implementar controle de requisições e boas práticas de integração para evitar bloqueios automáticos.
b - Qual o tempo de expiração do token gerado pela API?
R: 1 hora.
1. O que é API?
API (Interface de Programação de Aplicações) é um conjunto de definições e protocolos que permite que diferentes sistemas de software se comuniquem entre si. Ela garante que desenvolvedores possam integrar diferentes serviços e aplicativos, facilitando a troca de informações e funcionalidades de forma segura e eficiente.
2. Como gerar chaves para a API?
Ao acessar o Artia, clique no nome da sua empresa, localizado no canto superior esquerdo. Selecione a opção Configurar organização.
Figura 1 - Menu da organização com a opção Configurar organização destacada
No painel lateral ou na seção de configurações, localize e clique em Integrações.
Figura 2 - Tela de Configurar organização com a opção Integrações
Na aba superior da seção de integrações, clique na opção Gerar chaves para API. Preencha o nome do usuário e clique em Salvar.
Figura 3 - Tela de Gerar chaves para API com o campo para preenchimento do Nome
Após salvar, serão gerados um Client ID e um Secret.
Importante: Guarde o seu Secret, pois ele não será armazenado pela plataforma após essa etapa.
Figura 4 - Tela de Gerar chaves para API jã com o Nome, Client ID e Secret
3. Como gerar o Token?
Antes de realizar as operações básicas de projeto, pasta, atividades e afins, é necessário gerar o token de forma a poder informá-lo no Authorization (Type: Bearer Token) ou no cabeçalho (Header) das requisições. Neste artigo usaremos o Postman como exemplo.
Com o Postman aberto, clique em New ou em Criar nova requisição para iniciar a criação de uma nova requisição.
Figura 5 - Tela do Postman com a opção de criação de nova requisição sinalizada
No menu de criação da requisição, selecione HTTP como o método de comunicação.
Figura 6 - Lista suspensa com a opção de HTTP selecionada
Na lista de métodos HTTP, escolha POST para enviar dados ao servidor.
Figura 7 - Lista suspensa com as opções de método com POST selecionado
No campo de URL, insira a URL de endpoint da API: app.artia.com/graphql
Figura 8 - Campo de URL preenchido com a URL do Artia
Na aba Body, escolha a opção raw e depois, no menu suspenso ao lado, selecione JSON.
Figura 9 - Aba Body com as opções de raw e JSON configuradas
Copie e cole o código abaixo no campo Body, substituindo o ClientId e o Secret pelos seus próprios dados. Exemplo:
{
"query": "mutation { authenticationByClient(clientId: \"COLE AQUI SEU CLIENTID\", secret: \"COLE AQUI SEU SECRET\") { token } }"
}
Figura 10 - Tela do Postman com exemplo de código inserido
Após enviar a requisição, o retorno será o seu token de autenticação. Ele aparecerá na resposta da API.
Figura 11 - Tela do Postman com o retorno do token
3.1. A API possui limite de requisições e regras de segurança?
⚠️ Limite de requisições para geração de token:
A API do Artia possui controle de segurança com limite de 100 requisições por minuto por IP.
Caso esse limite seja ultrapassado: O IP poderá ser bloqueado automaticamente por 1 hora.
🚨 Orientações importantes sobre riscos e segurança:
Manter volumes elevados de requisições sem controle pode gerar bloqueios automáticos e impactar a disponibilidade da integração.
Requisições excessivas podem ser interpretadas como comportamento suspeito pelos mecanismos de proteção do sistema.
Boas práticas recomendadas:
Implementar cache de token (o token possui validade de 1 hora).
Reutilizar o token até sua expiração.
Evitar gerar um novo token a cada requisição da API.
Implementar controle de fila ou rate limit na aplicação.
4. Documentação de API
Para visualizar a nossa documentação de API, acesse este link: https://documenter.getpostman.com/view/10208526/TVCZaWK4
5. Exemplos de integração
Para facilitar o entendimento de como realizar integrações com a API do Artia, disponibilizamos um repositório com exemplos práticos de uso:
🔗 Artia API Examples no GitHub
Neste repositório, você encontrará pontos e comentados que demonstram como utilizar os principais endpoints da API do Artia, com aplicações em diversos cenários, como:
Criação de tarefas automaticamente;
Atualização de status de projetos;
Geração de relatórios personalizados;
Integração com sistemas externos;
Automatização de rotinas de acompanhamento.
Recomendamos clonar o repositório e testar os exemplos em um ambiente seguro para melhor compreensão do funcionamento da API.
Após esta explicação ainda restam dúvidas? Então fale diretamente com um de nossos consultores no chat do https://artia.com/ ou através do e-mail: [email protected]