Com certeza! A API da monday.com é construída em GraphQL e oferece muita flexibilidade para acessar e alterar informações na sua conta da monday.com.
Por que GraphQL?
Os usuários da monday.com utilizam a plataforma para gerenciar todos os tipos de informações, e a equipe da monday.com queria construir uma API tão flexível quanto a plataforma. Portanto, foi criada uma API que pode lidar com consultas expressivas para obter exatamente as informações necessárias, quando necessário. Se você quiser saber mais sobre GraphQL como linguagem de consulta, confira graphql.org. 😄
Documentação e testes
Para facilitar o uso da API, a equipe da monday.com escreveu documentação explicando as consultas e mutações que você pode fazer com seus dados. Você também pode testar suas consultas em nosso explorador GraphQL.
Autenticando com seu Token da API
Qualquer solicitação à API deve ser acompanhada por um Token da API, para que possamos saber que você é você. 😊
API para usuários administradores
Cada administrador na conta possui seu próprio Token da API — certifique-se de mantê-lo seguro! Para gerar seu Token da API:
- Faça login na sua conta da monday.com.
- Clique no seu avatar no canto superior direito.
- Escolha a aba Administração.
- Clique em Conexões no lado esquerdo da página de administração.
- No menu suspenso, clique em Token da API pessoal.
- Clique no botão Copiar à direita do Token da API pessoal. Isso é o que você deve estar vendo:
API para usuários não administradores
Se você não é um administrador da sua conta da monday.com, pode obter seus Tokens da API na seção de desenvolvedores, seguindo estas etapas:
- Faça login na sua conta da monday.com.
- Clique no seu avatar no canto superior direito.
- Selecione Desenvolvedores.
- Clique em Desenvolvedor e depois em Meus Tokens de Acesso no topo.
- Ao selecionar Mostrar ao lado do token da API, você poderá copiá-lo também.
Você pode usar este token da API para autenticar todas as suas solicitações à API, bem como em nosso ambiente de testes. O token pode ser regenerado a qualquer momento, mas observe que isso fará com que o antigo expire.
Tokens da API gerados através do OAuth
Você também pode gerar um token para aplicativos específicos usando o Fluxo de Autorização OAuth. As permissões desses tokens são limitadas com base nos escopos de autorização do aplicativo ao qual estão vinculados. Para mais informações, confira nossa documentação sobre OAuth.
Permissões do Token da API
O Token da API de cada usuário está vinculado às permissões desse próprio usuário.
Por exemplo, se o usuário tem acesso somente leitura a um determinado quadro, o Token da API não poderá atualizar nenhuma informação nesse quadro.
Da mesma forma, se um usuário não tiver acesso a um quadro privado — qualquer aplicativo que use o Token da API também não terá acesso a esse quadro.
Acessando nossa API GraphQL
Sabemos que os usuários gostam de testar as coisas antes de implementá-las, então incluímos um editor de consultas diretamente em nossa plataforma! Você pode usar isso para experimentar consultas e mutações antes de implementá-las em sua aplicação. Para usar o explorador da API, vá para este link.
Depois de abrir a página do explorador, insira seu Token da API neste campo:
Após fornecer seu token, você entrará em nosso ambiente de testes. O painel esquerdo do explorador é onde você insere sua consulta ou mutação, e quando você pressiona Play no canto superior esquerdo, o painel direito conterá seus resultados.
Você também pode clicar no botão Docs no canto superior direito para acessar nossa documentação diretamente do explorador. Para acessar nossa documentação fora do explorador, confira este link!
Enviando solicitações
Então, você testou suas consultas e está pronto para enviá-las diretamente de sua aplicação? Bem, você veio ao lugar certo. 😊
Todas as solicitações ao nosso servidor devem ser solicitações POST enviadas para api.monday.com/v2.
Certifique-se de usar o tipo de conteúdo application/json e passe sua chave da API como um parâmetro “Authorization” nos cabeçalhos:
{
"Content-Type" : "application/json",
"Authorization" : "mySuperSecretAPIKey"
}
O corpo da solicitação é onde sua consulta e variáveis são passadas. Deve parecer assim:
{
"query" : "...",
"variables" : {"myVariable" : "foo", "yourVariable" : "bar"}
}
Coleção Postman
Coletamos exemplos das solicitações de API mais comuns em uma coleção Postman. Você pode usá-la para testar solicitações de exemplo com nossa API e gerar trechos de código para copiar em sua aplicação. Dê uma olhada nos exemplos para que você possa testar suas próprias solicitações.
Por que usar a API?
Não tem certeza se precisa usar a API ou não? A API permite que aplicativos personalizados acessem o monday work OS, para que você possa conectar seus próprios scripts, integrações e ferramentas aos seus fluxos de trabalho. Se isso parece interessante para você, então a API é para você.
Você pode usar a API de várias maneiras para potencializar seus fluxos de trabalho. Aqui estão alguns exemplos:
- Conectando a integrações de dados de terceiros
- Configurando ferramentas de integração sem código como Zapier para criar fluxos de dados personalizados
- Importando e exportando dados em lotes
- Usando a API como uma camada de dados para aplicativos personalizados da monday.com se conectarem à monday.com
Como ir mais longe
A plataforma da monday.com também contém ferramentas para construir aplicativos que estão incorporados em seus fluxos de trabalho – como visualizações de quadros de aplicativos, integrações e mais.
Se você precisar de ainda mais opções para aprimorar seus fluxos de trabalho, pode usar o framework de aplicativos da monday.com para criar aplicativos sob medida para necessidades específicas dentro do seu espaço de trabalho. Saiba mais na nossa documentação do Framework de Aplicativos e mergulhe em nossos exemplos.
Limites de taxa
Os limites de taxa da API são baseados no nível de complexidade, que é limitado a 10.000.000 / minuto por conta. Você pode aprender mais sobre isso aqui!
Feliz codificação!
Agora que você tem uma compreensão básica de como enviar solicitações para nossa API, vá em frente e confira nossa documentação da API. Você também pode experimentar nosso ambiente de testes!
E por último, mas não menos importante, confira nossos tutoriais de início rápido em diferentes linguagens de programação:
- Tutorial de Início Rápido da API – Javascript
- Tutorial de Início Rápido da API – PHP
- Tutorial de Início Rápido da API – Python
Precisa de mais ajuda? O suporte da monday.com está à disposição.
E se você busca otimizar o uso da monday.com no seu time, a Audatia (parceira oficial no Brasil) tem especialistas prontos para ajudar com consultoria e treinamentos. Fale com um consultor →
