Neste artigo:

1. O que é API?
2. Como gerar chaves para a API?
3. Como gerar o Token?
4. Limite de requisições e regras de segurança
5. Documentação de API
6. Exemplos de integração
7. FAQ

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 possibilita que desenvolvedores integrem 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?

1. No Artia, clique no nome da sua empresa no canto superior esquerdo e selecione Configurar Organização.

Menu da organização com a opção Configurar Organização

1. No painel de configurações, localize e clique em Integrações.

Tela de Configurar Organização com a opção Integrações

1. Na aba superior da seção de integrações, clique em Gerar chaves para API, preencha o nome do usuário e clique em Salvar.

Tela de Gerar chaves para API

Após salvar, serão gerados um Client ID e um Secret.

Tela com o Client ID e Secret gerados

⚠️ Importante

Guarde o seu Secret imediatamente após a geração, pois ele não será armazenado pela plataforma após essa etapa.

3. Como gerar o Token?

Antes de realizar operações com projetos, pastas, atividades e outros objetos, é necessário gerar um token para informá-lo no Authorization (Type: Bearer Token) ou no cabeçalho das requisições. O exemplo abaixo utiliza o Postman.

1. Com o Postman aberto, clique em New para criar uma nova requisição.
   
   
2. Selecione HTTP como método de comunicação.
   
   
3. Na lista de métodos HTTP, escolha POST.
   
   
4. No campo de URL, insira: app.artia.com/graphql
   
   
5. Na aba Body, selecione raw e depois JSON.
   
   
6. Cole o código abaixo no campo Body, substituindo os valores pelo seu Client ID e Secret:
   json

{
  "query": "mutation { authenticationByClient(clientId: \"COLE AQUI SEU CLIENTID\", secret: \"COLE AQUI SEU SECRET\") { token } }"
}

Por fim, envie a requisição. O token de autenticação será retornado na resposta da API.

Retorno do token no Postman

4. Limite de requisições e regras de segurança

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.

⚠️ Atenção

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, já que ele possui validade de 1 hora
• Reutilizar o token até sua expiração, evitando gerar um novo a cada requisição
• Implementar controle de fila ou rate limit na aplicação para evitar bloqueios automáticos

5. Documentação de API

Para acessar a documentação completa da API do Artia, acesse: Documentação Postman

6. Exemplos de integração

Para facilitar o entendimento de como realizar integrações com a API do Artia, está disponível um repositório com exemplos práticos de uso no Artia API Examples no GitHub.

No repositório, você encontrará exemplos comentados que demonstram como utilizar os principais endpoints da API em 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.

7. FAQ

• Existem limitações de requisição para a API?
  Sim. A API possui limite de 100 requisições por minuto por IP. Se ultrapassado, o IP pode ser bloqueado por 1 hora.
• Qual o tempo de expiração do token gerado pela API?
  O token expira em 1 hora.

Ainda tem dúvidas? Fale com um de nossos consultores pelo chat em artia.com ou pelo e-mail [email protected].