API da Kinsta

A API REST da Kinsta é uma ferramenta poderosa projetada para permitir que desenvolvedores acessem e interajam facilmente com sua conta e projetos na Kinsta. Nossa API oferece uma maneira simplificada e eficiente de trabalhar com nossa plataforma, permitindo que você recupere dados, execute ações e automatize tarefas de maneira eficiente.

Para ter acesso a todos os detalhes sobre os endpoints disponíveis da API, além de baixar nossa especificação OpenAPI e experimentar os endpoints, você pode consultar nossa Referência de API.

Para se conectar com outros desenvolvedores e encontrar tutoriais detalhados, dicas e práticas recomendadas para usar a API REST da Kinsta, confira a categoria API da Kinsta em nosso fórum da Comunidade Kinsta.

Pré-requisitos

Para utilizar a API da Kinsta, é necessário possuir uma conta e, no mínimo, um site WordPress, aplicativo ou banco de dados hospedado no MyKinsta. Além disso, é preciso gerar uma chave API para autenticação e acesso à sua conta por meio da API.

Autenticação e acesso de usuários (Chave API)

Para acessar e usar a API com sua conta, primeiro você precisará gerar uma chave API no MyKinsta. Para começar, vá para a página Chaves API (Seu nome > Configurações da empresa > Chaves API) e clique em Criar chave API.

1. Escolha uma expiração ou defina uma data de início personalizada e o número de horas para a chave expirar.
2. Dê um nome à chave.
3. Clique em Gerar.

Quando a chave API é fornecida, este é o único momento em que você pode vê-la. Certifique-se de copiá-la e armazená-la em um local seguro.

Os proprietários, administradores e desenvolvedores da empresa podem criar chaves API. O nível de acesso à API dependerá do acesso do usuário. Por exemplo, uma chave API gerada por um desenvolvedor da empresa não terá o mesmo acesso que uma chave gerada por um proprietário ou administrador da empresa.

Você pode gerar várias chaves API, que estão listadas na página Chaves API. Se você precisar revogar uma chave API, clique em Revogar ao lado da chave que deseja revogar.

Endpoints da API

Com a API da Kinsta, você pode executar as seguintes ações:

Hospedagem de WordPress

• Obter uma lista dos sites WordPress da sua empresa, detalhes sobre um site específico e detalhes sobre o ambiente do site.
• Criar um novo site WordPress, clonar um site existente, criar um site vazio sem WordPress e excluir um site.
• Criar um novo ambiente de teste, enviar um ambiente de teste para produção e excluir um ambiente de teste.
• Limpar o cache do site, reiniciar e atualizar o PHP e obter uma lista de endereços IP negados.
• Obter uma lista de plugins e temas do seu site e atualizá-los.
• Adicionar ou remover um domínio.
• Limpar o Edge Cache e o cache do CDN no seu site.
• Obter uma lista de backups do site e uma lista de backups disponíveis para download, restaurar um backup e excluir um backup.
• Obter os arquivos de registro do site.

Hospedagem de Site Estático

• Obter uma lista de sites estáticos da sua empresa e detalhes sobre um site específico, atualizar as configurações do site e excluir um site.
• Obter os detalhes da implantação de um site estático e fazer a implantação manual ou programática do seu site.

Hospedagem de Aplicativos

• Obter uma lista de aplicativos da sua empresa e detalhes sobre um aplicativo específico, incluindo detalhes da implantação e processos, atualizar configurações do aplicativo e excluí-lo.
• Obter os detalhes da implantação de um aplicativo e fazer a implantação manual ou programática do seu aplicativo.
• Obter informações dos dados analíticos do seu aplicativo.
• Criar uma conexão interna entre seu aplicativo e banco de dados.
• Habilitar o CDN e Edge Caching e limpar o cache de ambos.

Hospedagem de Banco de Dados

• Obter uma lista de bancos de dados da sua empresa e detalhes sobre um banco de dados específico, criar um novo banco de dados, atualizar as configurações do banco de dados e excluir um banco de dados.

Empresa

• Obter uma lista de usuários da sua empresa, incluindo endereço de e-mail, nome completo e link para a foto de perfil.

Casos de uso comuns

Relatórios

As APIs podem ser usadas para ler dados e criar seus próprios relatórios ou integrar os serviços da Kinsta aos seus sistemas internos de monitoramento. Por exemplo, se você administra uma agência e usa um aplicativo que lista todos os seus clientes, pode usar a API para listar todos os sites WordPress, aplicativos e bancos de dados hospedados na Kinsta pertencentes a cada cliente.

Tarefas agendadas

Você pode criar seu próprio aplicativo para agendar tarefas durante a madrugada que possam impactar o desempenho do site ou causar indisponibilidade. Por exemplo, limpar o cache do site durante a noite pode ajudar a minimizar interrupções para os visitantes.

Gerenciamento de sites

Usando Node.js com a API, você pode criar um Slackbot para gerenciamento de sites, economizando tempo e ajudando a gerenciá-los de forma mais eficiente. O Slackbot pode ser usado para tarefas como verificar o status do site, limpar o cache e reiniciar o mecanismo PHP do site.

Criação de sites WordPress

Você pode adicionar um novo site/instalação WordPress automaticamente usando a API. Por exemplo, se você gerencia uma agência e deseja automatizar o processo de criação de sites sem precisar acessar o MyKinsta toda vez, pode usar a API para criar o site e instalar o WooCommerce, Yoast SEO e Easy Digital Downloads.

Também é possível criar uma instalação WordPress Multisite (is_multisite TRUE) e configurar como subdomínio (is_subdomain_multisite TRUE) ou subdiretório (is_subdomain_multisite FALSE).

Para verificar o status da criação do site, use o endpoint de Operações.

Verificação do status da operação

Para operações potencialmente de longa duração (por exemplo, criação de site, limpeza de cache, reinicialização do PHP, etc.), a API não responde imediatamente com o resultado. Isso ajuda a evitar um possível bloqueio de thread do servidor ou tempo limite do gateway por uma operação demorar muito tempo.

Para verificar o status de uma operação, use o endpoint /operations. Quando você iniciar uma operação, a resposta imediata da API incluirá um operation_id para ser usado com o endpoint /operations. Para obter mais detalhes e exemplos, consulte a Referência de Operações.

Limite de taxa

Para proteger a API contra sobrecarga de solicitações, o número de requisições por minuto é limitado da seguinte forma:

• 120 solicitações por minuto por ID de empresa, identificado pela Chave API.
• 1000 solicitações por minuto por endereço IP. Esse limite entra em vigor se você tiver acesso a várias empresas.
• 5 solicitações por minuto para criação de recursos, por exemplo, criar um site WordPress.

Para ver o status atual do seu limite de taxa, verifique os cabeçalhos RateLimit na resposta mais recente da API. Atualmente, não é possível aumentar esse limite.

Solução de problemas

Referência de API

Para obter detalhes completos sobre os endpoints de API disponíveis, para fazer download da nossa especificação OpenAPI e para experimentar os endpoints, consulte nossa Referência de API.