Uma chave de API permite que um desenvolvedor, ou uma ferramenta que você usa, utilize a Open API do Mateflow para ler e gravar os dados da sua comunidade. Você cria e revoga chaves de API em Admin → Configurações → Integrações → Acesso à API. Cada chave funciona para uma única comunidade.
Quem pode fazer isso: proprietários e administradores. · Onde: web (console de administração). · Plano: o acesso à API, e quantas requisições de API por dia sua comunidade pode fazer, dependem do seu plano da plataforma.
As chaves de API são por comunidade
As chaves de API pertencem a uma única comunidade, e as requisições feitas com uma chave sempre agem sobre essa comunidade. Para conectar várias comunidades, crie uma chave no console de administração de cada uma.
O painel do criador (app.mateflow.com) não tem chaves de API. As chaves do espaço de trabalho que existiam lá foram substituídas por chaves por comunidade. A página Visão geral de uma comunidade no painel tem um link para a página Integrações dela.
Criar uma chave de API
- Acesse Admin → Configurações → Integrações e abra a aba Acesso à API.
- Clique em Gerar Nova Chave.
- Informe um Nome da Chave que diga para que ela serve, como a ferramenta que vai usá-la.
- Em Escopos e Permissões, marque só as permissões de que a integração precisa. Veja a próxima seção.
- Opcional: em Lista de IPs Permitidos (Opcional), informe os endereços IP ou os intervalos que podem usar a chave, separados por vírgulas.
- Clique em Gerar Nova Chave.
- Copie a chave em Chave de API Gerada, guarde-a em um lugar seguro e clique em Concluído.
Você só consegue ver a chave completa uma vez. Se perdê-la, gere uma chave nova e revogue a antiga.
Se a aba Acesso à API mostrar um aviso de upgrade, o seu plano da plataforma não inclui acesso à API. O card Endpoint da API mostra a URL base das requisições e o limite diário de requisições do seu plano, que é zerado às 00:00 UTC.
Escopos (permissões) das chaves de API
| Escopo | O que ele permite |
|---|---|
| Ler comunidade | Ler o perfil, as configurações e os metadados da comunidade |
| Ler conteúdo | Ler publicações, feeds, respostas e resultados de pesquisa |
| Escrever conteúdo | Criar, editar e excluir publicações e respostas |
| Enviar mídia | Solicitar tokens de upload; também cobre a leitura de URLs assinadas de mídia |
| Ler mídia | Ler URLs assinadas de mídias existentes |
| Ler espaços | Listar espaços e ler os detalhes dos espaços |
| Ler membros | Buscar membros e ler perfis básicos, incluindo os grupos de acesso deles |
| Convidar membros | Convidar pessoas por e-mail ou por um link de convite |
Ler membros e Convidar membros aparecem em Acesso sensível. Ler membros permite que a integração verifique se um endereço de e-mail pertence à sua comunidade. Com Convidar membros, os convites são enviados em nome do proprietário da comunidade, a menos que a integração indique outra pessoa como remetente, e as pessoas convidadas sempre entram como membros. Os convites pela API podem incluir grupos de acesso. Veja Como funcionam os grupos de acesso.
Os escopos de uma chave não podem ser alterados depois. Chaves mais antigas podem mostrar Todos (legado): elas mantêm só os escopos que existiam quando foram criadas. Crie uma chave nova para usar os escopos mais recentes.
Revogar uma chave de API
- Na aba Acesso à API, encontre a chave em Chaves de API.
- Abra o menu de ações dela e clique em Revogar Chave.
- Confirme. A revogação não pode ser desfeita, e qualquer ferramenta que use a chave para de funcionar.
A lista mostra o Status (Ativa, Expirada ou Revogada) e a data de Último Uso de cada chave. As requisições da API não aparecem em Logs de Entrega, então é pelo Último Uso que você confere se uma chave ainda está em uso. Desconectar o Slack, o Discord ou o Zapier não revoga nenhuma chave de API.
Manter as chaves de API seguras
- Mantenha as chaves de API em um servidor, não em um site ou app que outras pessoas possam baixar, e envie as requisições por HTTPS.
- Dê a cada ferramenta a sua própria chave, só com os escopos de que ela precisa, para poder revogar uma sem quebrar as outras.
- Adicione uma Lista de IPs Permitidos quando a ferramenta fizer as chamadas a partir de endereços fixos.
- Revogue uma chave na hora se ela puder ter vazado e depois crie uma substituta.
Onde encontrar a documentação da API
A referência da API cobre os endpoints, os formatos de requisição e de resposta, os escopos, os códigos de erro e exemplos de código. Na aba Acesso à API, o card Documentação para desenvolvedores tem um botão Abrir documentação que leva a mateflow.com/developers. Envie esse link ao seu desenvolvedor. Ele não precisa de uma conta na sua comunidade, e a página fica disponível mesmo que o seu plano não inclua acesso à API.
Artigos relacionados
Este guia foi útil?