A API REST (Interface de Programação de Aplicativos) da Kinsta é uma ferramenta poderosa projetada para permitir que os desenvolvedores acessem e interajam facilmente com sua conta e projetos da 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.

Pré-requisitos

Para usar a API da Kinsta, você deve ter uma conta e pelo menos um site WordPress, aplicativo ou banco de dados no MyKinsta. Você também precisará gerar uma chave API para autenticar e acessar sua conta através da API.

Casos de uso comuns

Relatórios

As APIs podem ser usadas para ler dados, permitindo que você crie seus próprios relatórios ou integrar os Serviços da Kinsta em seus sistemas internos de rastreamento. Por exemplo, se você administra uma agência e utiliza um aplicativo que lista todos os seus clientes, é possível utilizar 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 noite que possam afetar o desempenho do seu site ou causar tempo de inatividade. Por exemplo, limpar o cache do site durante a noite pode ajudar a minimizar a interrupção para os visitantes do site.

Gerenciamento de sites

Usando Node.js com a API, você pode criar um Slackbot para gerenciamento de sites que economiza tempo e ajuda a administrar seus sites de forma mais eficiente. Você pode usar o Slackbot para tarefas como verificar o status do site, limpar o cache do site e reiniciar o mecanismo PHP do site.

Criação de sites WordPress

Você pode adicionar um novo site/instalação do WordPress automaticamente usando a API. Por exemplo, se você administra uma agência e deseja automatizar o processo de criação de sites sem precisar fazer login no MyKinsta todas as vezes, você pode usar a API para criar o site e instalar o WooCommerce, o Yoast SEO e o Easy Digital Downloads.

Você também tem a opção de criar uma instalação do WordPress Multisite (is_multisite TRUE) e configurar um 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 extremidade Operations (Operations endpoint).

Autenticação e acesso do usuário

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 for fornecida, este será o único momento em que você poderá 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.

Verifique o 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 da thread do servidor ou tempo limite do gateway devido ao fato de 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 ponto de endpoint /operations. Para obter mais detalhes e exemplos, consulte a referência de Operações.

Limite de taxa (Rate Limit)

Para proteger nossa API de ser sobrecarregada com um grande número de solicitações, o número de solicitações por minuto é limitado a 60. No entanto, há uma exceção para a criação de sites, que é limitada a 5 solicitações por minuto.

Para ver o status atual do limite de taxa, verifique os cabeçalhos RateLimit na resposta mais recente da API:

RateLimit-Limit: 60

RateLimit-Remaining: 50

RateLimit-Reset: 60

Atualmente, não é possível aumentar o limite de taxa.

Solução de problemas

Se você fizer uma solicitação a um endpoint para o qual sua chave de API não tem acesso, você receberá uma mensagem de erro informando que você não tem acesso. Se você precisar de acesso a esse endpoint, um proprietário ou administrador da empresa precisará gerar uma chave de API para você.

Referência da API

Para obter todos os detalhes sobre os endpoints disponíveis na API, baixar nossa especificação OpenAPI e testar os endpoints, consulte nossa Referência da API.

Documentação relacionada

Conteúdo referenciado