Tradicionalmente, nossos serviços na Kinsta dependiam de interações manuais por meio do MyKinsta, limitando o escopo apenas a interações humanas. Mas espere um pouco porque tudo está prestes a mudar!

Estamos introduzindo a revolucionária API (Interface de Programação de Aplicativos) da Kinsta.

Diga adeus às limitações do passado e desfrute de uma era revolucionária em que as máquinas podem interagir perfeitamente com nossos serviços. Isso significa que agora você pode executar tarefas em seu site Kinsta sem fazer login no MyKinsta.

O que é possível com a API da Kinsta

Agora você pode executar tarefas remotamente com facilidade e eficiência incomparáveis. Aqui estão os casos de uso da API da Kinsta:

1. Relatórios

Com a API da Kinsta, você pode integrar perfeitamente os serviços Kinsta em seus sistemas de rastreamento internos. Se você é uma agência que busca listar todos os sites, aplicativos e bancos de dados WordPress de seus clientes ou um entusiasta de dados que busca criar painéis personalizados, nossa API permite que você recupere dados analíticos da Kinsta sem esforço.

2. Tarefas programadas

Não há mais tarefas manuais noturnas que afetem o desempenho do seu site, pois com a API da Kinsta, você pode criar aplicativos para agendar tarefas, garantindo o mínimo de interrupção para seus visitantes. Seja limpando o cache ou executando operações críticas, nossa API permite que você automatize essas tarefas sem esforço.

3. Criação de sites WordPress

Usando a API da Kinsta, você pode criar um novo site/instalação do WordPress automaticamente. Você também pode assumir o controle da funcionalidade do seu site instalando plugins populares, como o WooCommerce e o Yoast SEO, diretamente da API.

Mas isso não é tudo! Com a API da Kinsta, você também pode criar instalações do WordPress Multisite e configurar um subdomínio (is_subdomain_multisite TRUE) ou subdiretório (is_subdomain_multisite FALSE).

Primeiros passos com a API Kinsta

Para começar a usar a API da Kinsta, você deve ter uma conta ativa na Kinsta com pelo menos um site, aplicativo ou banco de dados de WordPress no MyKinsta. Além disso, você precisa gerar uma chave de API para autenticar e acessar sua conta.

Autenticação e acesso do usuário

Para gerar uma chave de API, você precisa:

  1. Acessar o Painel MyKinsta.
  2. Navegar até a página Chaves API (Seu nome > Configurações da empresa > Chaves API).
  3. Clicar em Criar chave API.
  4. Escolher uma expiração ou definir uma data de início personalizada e o número de horas para a chave expirar.
  5. Dar um nome exclusivo à chave.
  6. Clicar em Gerar.
Criando a chave API no MyKinsta.
Criando a chave API no MyKinsta.

Quando a chave API for criada, certifique-se de copiá-la e armazená-la em algum lugar seguro, pois essa é a única vez que você poderá vê-la.

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

Permissões

Implementar vários níveis de acesso para chaves de API ajuda a controlar o acesso às APIs. Para a API da Kinsta, o nível de acesso à API dependerá da função do usuário, pois proprietários da empresa, administradores e desenvolvedores podem criar chaves de API.

Por exemplo, uma chave de 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.

Aproveite a automação com a API da Kinsta

Após obter sua chave API, você pode continuar aproveitando a automação com a API da Kinsta. A documentação de referência da API da Kinsta fornece uma explicação detalhada de cada endpoint, como consultá-los, os parâmetros necessários e as possíveis respostas, juntamente com exemplos de solicitação e resposta.

Por exemplo, para obter uma lista dos aplicativos da sua empresa, use o endpoint applications para obter uma lista dos aplicativos da sua empresa. Esse endpoint requer o parâmetro company com um valor do ID da sua empresa (você pode obter essas informações na página Detalhes de faturas no MyKinsta). Quando você enviar uma solicitação GET para o endpoint (https://api.kinsta.com/v2/applications?company=UNIQUE_COMPANY_ID), ele retornará dados JSON que incluem os aplicativos da sua empresa:

{
    "company": {
        "apps": {
            "items": [
                {
                    "id": "ccd26ccb-8e78-4cf0-a5b2-2ab5d1a23760",
                    "name": "chatgpt-clone-g9q10",
                    "display_name": "chatgpt-clone",
                    "status": "deploymentSuccess"
                },
                {
                    "id": "1adf1e9c-f35e-491e-bec9-fe00ad9f2086",
                    "name": "kinsta-developer-portfolio-ir8w8",
                    "display_name": "Kinsta-developer-portfolio",
                    "status": "deploymentSuccess"
                },
            ]
        }
    }
}

Há mais coisas que você pode fazer com a API da Kinsta, conforme documentado na documentação de referência da API da Kinsta.

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 de 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. Isso retornará o status da operação. Por exemplo:

{
  "status": 202,
  "message": "Operation in progress",
  "data": null
}

Este endpoint operations requer o operation_id como um parâmetro de caminho que você obterá em uma resposta 202 Accepted quando executar qualquer operação de longa duração. Para obter mais detalhes e exemplos, consulte a referência de operações.

Limite de taxa

Para proteger nossa API contra um grande volume de solicitações, o número de solicitações por minuto é limitado a 60. A exceção é 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

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

Solução de problemas

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

Você pode liberar o poder da automação e aumentar a eficiência com a conveniência da API da Kinsta. Você pode começar agora mesmo!