Leitura de 7 minutos

Recurso

Claro que temos! Nossa API é construída em GraphQL e oferece muita flexibilidade para acessar e alterar informações na sua conta da monday.com.

Dica: Para mais informações detalhadas sobre tudo referente à API, confira nossa documentação da API!

Por que GraphQL?

Nossos usuários usam a monday.com para gerenciar todos os tipos de informações e queríamos uma API que fosse tão flexível quanto nossa plataforma. Assim, criamos uma API capaz de lidar com queries expressivas para obter exatamente as informações de que você precisa, sempre. Se quiser saber mais sobre GraphQL como uma linguagem de query, confira graphql.org. 😄

Documentação e testes

Para facilitar o uso da nossa API, temos uma documentação escrita explicando as queries e mutações que você pode fazer em seus dados. Você também pode testar suas queries em nosso explorador GraphQL.

Autenticação com seu token de API

Qualquer solicitação à nossa API deve ser acompanhada por um token de API, para que saibamos que você é realmente você. 😊

API para usuários administradores

Cada administrador na conta tem seu próprio token de API. Certifique-se de mantê-lo seguro! Para gerar seu token de API:

Faça login na sua conta da monday.com.
Clique em seu avatar no canto superior direito.
Selecione ”Administração”.
Clique em "Conexões" à esquerda da página Admin.
Selecione "API" no menu superior.
Clique no botão "Copiar" localizado à direita do token pessoal da API. Você deve ver algo parecido com a tela abaixo:

Admin API Token.png

API para usuários não administradores

Se você não é um administrador na sua conta da monday.com, pode obter seus tokens de API na seção de desenvolvedores, seguindo estas etapas:

Faça login na sua conta da monday.com.
Clique em seu avatar no canto superior direito.
Selecione "Desenvolvedores".
Clique em "Desenvolvedor" e depois em "Meus tokens de acesso" na parte superior.
Ao selecionar "Exibir" ao lado do token da API, você também poderá copiá-lo.

Você pode usar esse token de API para autenticar todas as suas solicitações em nossa API, assim como em nosso ambiente de teste. O token pode ser regenerado a qualquer momento, mas note que tal medida acarretará na expiração do token antigo.

Tokens de 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 obter mais informações, confira nossa documentação sobre OAuth.

Permissões de token de API

O token de API de cada usuário tem escopo para as permissões desse próprio usuário.

Por exemplo, se o usuário tiver acesso do tipo somente leitura a um determinado quadro, o token de 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.

Nota: no momento, não somos compatíveis com tokens de API de "superusuário" que têm acesso de leitura e gravação a todos os quadros de uma conta.

Acessando nossa API GraphQL

Sabemos que nossos usuários gostam de testar as coisas antes de implementá-las, por isso incluímos um editor de queries diretamente na nossa plataforma! Você pode usá-lo para testar queries e mutações antes de implementá-las no seu aplicativo. Para usar o explorador de API, acesse este link.

Depois de abrir a página do explorador, insira seu token de API nesse campo:

Após fornecer seu token, você entrará em nosso ambiente de teste. O painel à esquerda do explorador é onde você insere sua query ou mutação, e quando você clica em "reproduzir" no canto superior esquerdo, o painel direito exibirá seus resultados.

Você também pode clicar no botão "Docs" no canto superior direito para acessar nossa documentação diretamente no explorador. Para acessar nossa documentação fora do explorador, clique neste link!

Enviando Solicitações

Você testou suas queries e está tudo pronto para enviá-las diretamente do seu aplicativo? Bom, você chegou ao lugar certo. 😊

Todas as solicitações ao nosso servidor devem ser solicitações do tipo POST enviadas para api.monday.com/v2.

Certifique-se de usar o tipo de conteúdo application/json e introduzir sua chave de API como um parâmetro de "autorização" nos cabeçalhos:

{
    "Content-Type" : "application/json",
    "Authorization" : "mySuperSecretAPIKey"
}

O corpo da solicitação é onde sua query e as variáveis são introduzidas. Ele deve ser mais ou menos assim:

{ 
    "query" : "...",
    "variables" : {"myVariable" : "foo", "yourVariable" : "bar"}
}

Coleção do Postman

Reunimos exemplos das solicitações de API mais comuns em uma coleção Postman. Você pode usá-la para testar amostras de solicitações com nossa API e gerar trechos de código para copiar em sua aplicação. Confira os exemplos para que você possa testar suas próprias solicitações.

Por que usar a API?

Não sabe se precisa usar a API ou não? A API permite que aplicações personalizadas acessem o work OS da monday para conectar seus próprios scripts, integrações e ferramentas aos seus fluxos de trabalho. Caso tenha ficado interessado, a API é para você.

Você pode usar a API de várias formas para otimizar seus fluxos de trabalho. Aqui estão alguns exemplos:

Conectar-se a integrações de dados de terceiros
Configurar ferramentas de integração no-code como o Zapier para criar fluxos de dados personalizados
Importar e exportar dados em lotes
Usar a API como uma camada de dados para apps personalizados da monday se conectarem à monday

Como ir além

A plataforma da monday também contém ferramentas para criar aplicações integradas aos seus fluxos de trabalho – como visualizações de quadro de apps, integrações e muito mais.

Caso precise de ainda mais opções para aprimorar seus fluxos de trabalho, você pode usar a estrutura de apps da monday para criar aplicações personalizadas a necessidades específicas na sua área de trabalho. Saiba mais em nossa documentação da estrutura de apps e confira nossos exemplos em detalhes.

Limites de taxa

Os limites de taxa de API são baseados no nível de complexidade, que é limitado a 10.000.000/minuto por conta. Você pode saber mais sobre isso aqui!

Boa codificação!

Agora que você tem uma compreensão básica sobre como enviar solicitações para nossa API, confira nossa documentação da API. Você também pode experimentar nosso ambiente de teste!

E por último, mas não menos importante, confira nossos tutoriais de início rápido em diferentes linguagens de programação:

Se você tiver alguma dúvida, entre em contato com nossa equipe por aqui. Estamos disponíveis 24 horas e prontos para ajudar!

A monday.com tem uma API?