Logo ZenifraZenifra

API Zenifra

Documentação completa da API REST da Zenifra para gerenciamento de projetos via API Key.

API Zenifra

A API da Zenifra permite gerenciar seus projetos de forma programática. Todos os endpoints listados nesta documentação utilizam autenticação via API Key (header x-api-key).

Autenticação

Para utilizar a API, você precisa incluir o header x-api-key em todas as requisições. A API Key pode ser obtida nas configurações do seu projeto no console.

Header Necessário

HeaderDescrição
x-api-keySua API Key do projeto

URL Base

Todas as requisições devem ser feitas para:

https://api.zenifra.com/v1

Exemplo de Requisição

curl -X GET "https://api.zenifra.com/v1/project/{id}/metrics" \
  -H "x-api-key: sua-api-key-aqui"

Endpoints Disponíveis

Gerenciamento de Projeto

EndpointDescrição
Atualizar Imagem de DeployAtualiza a imagem Docker do projeto
Métricas e LogsObter métricas e logs do projeto
Informações do ProjetoAtualizar nome e descrição
Variáveis de AmbienteGerenciar variáveis de ambiente
DomínioAtualizar subdomain do projeto
Ciclo de VidaParar e retomar o projeto
PlanoAlterar plano do projeto
ArmazenamentoGerenciar armazenamento

Códigos de Status HTTP

CódigoDescrição
200Requisição bem sucedida
400Dados inválidos ou mal formatados
401API Key inválida ou não fornecida
404Projeto não encontrado
500Erro interno do servidor

Exemplos de Uso

Python

import requests

API_KEY = "sua-api-key"
BASE_URL = "https://api.zenifra.com/v1"

headers = {
    "x-api-key": API_KEY,
    "Content-Type": "application/json"
}

# Obter métricas do projeto
response = requests.get(
    f"{BASE_URL}/project/507f1f77bcf86cd799439011/metrics",
    headers=headers
)
print(response.json())

Node.js

const axios = require('axios');

const API_KEY = 'sua-api-key';
const BASE_URL = 'https://api.zenifra.com/v1';

const headers = {
  'x-api-key': API_KEY,
  'Content-Type': 'application/json'
};

async function getMetrics(projectId) {
  const response = await axios.get(
    `${BASE_URL}/project/${projectId}/metrics`,
    { headers }
  );
  return response.data;
}

getMetrics('507f1f77bcf86cd799439011')
  .then(console.log)
  .catch(console.error);

FAQ

Onde encontro a API Key e o Project ID do meu projeto?

Importante: Tanto a API Key quanto o Project ID são exibidos apenas uma vez, no momento da criação do projeto. Após essa tela inicial, não é mais possível acessá-los pelo console.

Por isso, guarde essas informações em local seguro imediatamente após criar seu projeto.

Posso usar a API Key para qualquer projeto?

Sim, cada projeto possui sua própria API Key. A chave garante acesso apenas ao projeto específico ao qual pertence.

Os endpoints possuem rate limiting?

Sim, a API possui rate limiting para garantir estabilidade. Se você exceder o limite, receberá erros 429 (Too Many Requests).