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.

Casos de uso comuns

Relatórios

As APIs permitem a leitura de dados, possibilitando a criação de relatórios personalizados ou a integração dos Serviços Kinsta aos seus sistemas internos de monitoramento. Por exemplo, se você gerencia uma agência e possui um aplicativo que reúne informações de todos os seus clientes, você pode utilizar a API para obter uma lista de todos os sites, aplicativos e bancos de dados hospedados na Kinsta que são associados a cada um dos seus clientes.

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 seu site.

Gerenciamento do site

Usando o Node.js com a API, você pode criar um Slackbot de gerenciamento de sites para economizar tempo e ajudá-lo a gerenciar seus sites com mais eficiência. Você pode usar o Slackbot para tarefas como verificar o status do site, limpar o cache de um site e reiniciar o mecanismo PHP de um site.

Criação de sites WordPress

Você pode adicionar um novo site/instalação 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, 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 WordPress Multisite (is_multisite TRUE) e configurar uma instalação de subdomínio (is_subdomain_multisite TRUE) ou subdiretório (is_subdomain_multisite FALSE).

Para verificar o status da criação do site, use o Operações 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 é 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.

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 nossa API de receber um número excessivo de solicitações, o número de solicitações por minuto é limitado a 60. Há uma exceção para a criação de sites, que tem um limite de 5 solicitações por minuto.

Para verificar o status atual do seu limite de taxa, consulte 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

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.