Introdução
Bem-vindo à documentação da plataforma de automação PixelPulse. Este guia irá ajudá-lo a configurar e utilizar todos os recursos disponíveis.
Pré-requisitos
- Acesso à internet
- Conta ativa no PixelPulse
- Conhecimento básico de APIs (para integrações avançadas)
Primeiros Passos
1. Crie sua Conta
Registre-se em nossa plataforma para obter suas credenciais de acesso.
2. Obtenha sua API Key
Na área de configurações, gere sua chave de API para começar as integrações.
3. Configure seu Primeiro Fluxo
Utilize nossa interface ou API para criar seu primeiro processo automatizado.
Referência API
Nossa API RESTful permite que você integre a plataforma PixelPulse com seus sistemas existentes.
Autenticação
Todas as requisições devem incluir seu API Key no header:
Authorization: Bearer YOUR_API_KEY
Endpoints Principais
GET /api/v1/flows
Lista todos os fluxos de automação disponíveis.
Exemplo de resposta:
{
"data": [
{
"id": "flow_123",
"name": "Importação de Dados",
"status": "active",
"last_run": "2023-07-15T10:32:45Z"
}
]
}
POST /api/v1/flows/{id}/execute
Executa um fluxo específico.
Exemplo de requisição:
{
"parameters": {
"source": "csv_import",
"file_url": "https://example.com/data.csv"
}
}
GET /api/v1/logs
Recupera os logs de execução.
Parâmetros opcionais:
{
"flow_id": "flow_123",
"status": "success",
"limit": 50
}
Exemplos
Node.js
const axios = require('axios');
const api = axios.create({
baseURL: 'https://api.pixelpulse.com/v1',
headers: {
'Authorization': `Bearer ${process.env.API_KEY}`
}
});
async function runFlow(flowId, params) {
try {
const response = await api.post(`/flows/${flowId}/execute`, params);
console.log('Execução iniciada:', response.data);
} catch (error) {
console.error('Erro:', error.response.data);
}
}
runFlow('flow_123', {
source: 'google_sheets',
sheet_id: '1xqH3YwW6zYD...'
});
Python
import requests
api_url = "https://api.pixelpulse.com/v1"
headers = {"Authorization": f"Bearer {API_KEY}"}
def get_flows():
response = requests.get(f"{api_url}/flows", headers=headers)
return response.json()
flows = get_flows()
print("Fluxos disponíveis:", flows)
cURL
curl -X POST \
https://api.pixelpulse.com/v1/flows/flow_123/execute \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"parameters": {
"source": "shopify",
"start_date": "2023-07-01"
}
}'
Solução de Problemas
Erro 401 - Não autorizado
Verifique se sua API Key está correta e incluída no header de autorização.
Erro 429 - Muitas requisições
Você excedeu o limite de requisições por minuto. Aguarde alguns instantes antes de tentar novamente.
Processos travados
Verifique o status do serviço em nosso status page. Se o problema persistir, reinicie o fluxo.
Perguntas Frequentes
Posso agendar execuções automáticas?
Sim, nossa plataforma permite agendamento recorrente ou baseado em eventos para todos os fluxos.
Quais formatos de arquivo são suportados?
CSV, JSON, XML, Excel e Google Sheets são totalmente suportados para importação/exportação.
Como monitoro o consumo da minha conta?
Na área de configurações você encontra um painel detalhado com seu consumo e limites.
Posso integrar com webhooks?
Sim, temos suporte completo para webhooks tanto para entrada quanto para saída de dados.