PromoPilot API

Una única API REST para todo el ecosistema de PromoPilot: lanza promoción de enlaces, rastrea posiciones, ejecuta auditorías SEO y escaneos de seguridad desde tu propio código: CRM, SaaS o un panel de agencia.

• URL base: https://promopilot.link/api/v1
• El formato es JSON sobre HTTPS; cada respuesta contiene un campo ok.
• Los proyectos creados mediante la API aparecen en el panel en una sección aparte llamada “Proyectos de API” y llevan una insignia: no se mezclan con los personales.
• Especificación legible por máquina: openapi.json

curl https://promopilot.link/api/v1/ping
# {"ok":true,"pong":true,"time":"2026-07-20T12:00:00Z"}

Autorización y claves

Las claves de API se emiten en el panel del cliente: Panel → API para desarrolladores. Al crear una clave eliges a qué servicios puede acceder (scopes): promotion, rank, audit, shield. La clave se muestra completa solo una vez: no almacenamos nada salvo su huella SHA-256.

Authorization: Bearer ppk_your_key# или
X-Api-Key: ppk_your_key

Facturación y saldo

• Todas las operaciones de pago se cargan al saldo personal de la cuenta, el mismo que ves en el panel. No existe un “saldo de API” aparte.
• Promoción: el precio proviene del plan, de la cascada flexible o del precio global, menos tu descuento personal; los suscriptores Pro obtienen automáticamente un 10% adicional de descuento.
• Puedes conocer el precio exacto antes de lanzar: POST /promotion/quote (sin cargo).
• Rank Tracker cobra por las comprobaciones realizadas realmente; SEO Audit completo se prepaga según la estimación de tamaño; Shield deep/comprehensive tiene un precio fijo por escaneo.
• Si no hay fondos suficientes recibes HTTP 402 insufficient_funds con los campos required, balance, shortfall y un enlace topup_url. La recarga se realiza en el panel.

Formato de errores

{
  "ok": false,
  "error": {
    "code": "insufficient_funds",
    "message": "No hay fondos suficientes en tu saldo. Recárgalo en el panel y repite la solicitud.",
    "details": {"required": 44.1, "balance": 10.0, "shortfall": 34.1, "topup_url": "…"}
  }
}

Límites

• 120 solicitudes por minuto por clave (el límite base).
• Lanzamientos de promoción: hasta 20 por minuto; creación de proyectos: hasta 30 por hora; lanzamientos de auditorías y escaneos: hasta 10 por minuto.
• Si superas el límite recibes HTTP 429 con un encabezado Retry-After. El intervalo recomendado para consultar el estado es una vez cada 30–60 segundos.

Localización

Los mensajes legibles (message) se devuelven en el idioma del parámetro ?lang= (ru, en, uk, pl) o del encabezado Accept-Language; por defecto, el idioma de tu cuenta. Los códigos de error y los estados para máquinas nunca se traducen: basa tu lógica en ellos.

Referencia de endpoints

Cuenta

{"ok":true,"user":{"id":2,"balance":124.50,"currency":"USD","promotion_discount_percent":10,"is_pro":true,...},"key":{"label":"CRM","scopes":["promotion"]}}

{"ok":true,"balance":124.50,"currency":"USD","topup_url":"…/client/balance.php"}

{"ok":true,"key":{"label":"CRM","scopes":["promotion","rank"],"requests_total":1520,...}}

Proyectos y enlaces scope: promotion

{"ok":true,"projects":[{"id":311,"name":"Client A","created_via":"api","links_count":3,"active_runs":1,...}]}

{"ok":true,"project":{"id":312,"created_via":"api",...},"links":{"added":2,"domain_errors":0}}

{"ok":true,"project":{"id":312,"links":[...],"runs":[...]}}

{"ok":true,"project":{...}}

{"ok":true,"deleted":true}

{"ok":true,"link":{"id":915,"url":"https://site.com/page",...},"links_count":4}

{"ok":true,"deleted":true}

Promoción (cascadas) scope: promotion

{"ok":true,"tariffs":[{"id":3,"slug":"pro","name":"Pro","price_per_link":49.0,"cascade":{...}}],"your_discount_percent":10}

{"ok":true,"pricing_mode":"tariff","base_price":49.0,"discount_percent":10,"brand_anchors_price":0,"total":44.1,"balance":124.5,"sufficient_funds":true}

{"ok":true,"project_id":744,"brand":"Ventana V","source":"page","brand_anchors_price":5}

{"ok":true,"run_id":501,"status":"queued","charged":49.1,"discount_percent":10,"balance_after":75.4,"currency":"USD","brand_anchors":true,"brand_name":"Ventana V"}

{"ok":true,"runs":[{"id":501,"status":"level1_active","progress":{"done":3,"total":12,"pct":25},...}],"pagination":{...}}

{"ok":true,"run":{"id":501,"status":"level2_active","levels":[{"level":1,"total":5,"verified":5},...]}}

{"ok":true,"run_id":501,"nodes":[{"level":1,"network":"telegraph","url":"https://telegra.ph/…","verified":true,...}]}

Informes y marca blanca (Pro) scope: promotion

{"ok":true,"run":{...},"summary":{"verified":12,...},"report":{"level1":[...],"level2":[...],"crowd":[...]},"whitelabel":{...}} — или {"ok":true,"pdf":{"url":"…/uploads/reports/api-cascade-501-….pdf"},"branded":true} — или {"ok":true,"file":{"url":"…/uploads/reports/acme-report-site.com-….xlsx","filename":"acme-report-site.com-2026-10-11.xlsx"},"format":"xlsx","branded":true}

{"ok":true,"is_pro":true,"branding_active":true,"branding":{"company_name":"Acme","logo_url":"…","accent_color":"#6366f1",...}}

{"ok":true,"branding":{...}}

Rank Tracker scope: rank

{"ok":true,"projects":[{"id":7,"domain":"site.com","region":"UA","keywords_count":50,"top10":12,...}]}

{"ok":true,"project":{"id":8,...}}

{"ok":true,"project":{...},"keywords":[{"id":91,"keyword":"ventanas de compra","last_position":4,"last_checked_at":"…"}]}

{"ok":true,"added":25,"skipped":0}

{"ok":true,"queued":50,"note":"…"}

SEO Audit scope: audit

{"ok":true,"projects":[{"id":4,"domain":"site.com","start_url":"https://site.com/",...}]}

{"ok":true,"project":{"id":5,...}}

{"ok":true,"has_estimate":true,"estimated_pages":430,"full_audit_price":5.0,"currency":"USD"}

{"ok":true,"crawl_id":88,"mode":"full","max_pages":500,"charged":5.0}

{"ok":true,"crawl":{"id":88,"status":"done","health_score":79,"pages_crawled":430,"issues":{...}}}

{"ok":true,"crawls":[...]}

Security Shield scope: shield

{"ok":true,"projects":[{"id":3,"domain":"site.com","verified":true,...}]}

{"ok":true,"project":{"id":3,"verified":false,"verify_token":"pp-verify-…"},"verification_hint":"…"}

{"ok":true,"verified":true,"method":"dns"}

{"ok":true,"scan_id":41,"mode":"deep","charged":19.0}

{"ok":true,"scan":{"id":41,"status":"done","score":86,"grade":"B","verdict":{...},"findings_summary":{"critical":0,"high":1,...},"share_report_url":"…"}}

Ejemplos de código

cURL — crear un proyecto y lanzar la promoción

curl -X POST https://promopilot.link/api/v1/projects \
  -H "Authorization: Bearer ppk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Client Site",
    "url": "https://client-site.com",
    "language": "ru",
    "links": [{"url": "https://client-site.com/services", "anchor": "servicios de la empresa"}]
  }'

curl -X POST https://promopilot.link/api/v1/promotion/runs \
  -H "Authorization: Bearer ppk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"project_id": 312, "url": "https://client-site.com/services"}'

PHP

<?php
$key = getenv('PROMOPILOT_API_KEY'); // nunca guardes la clave en tu código
function pp_api(string $method, string $path, array $data = null) {
    global $key;
    $ch = curl_init('https://promopilot.link/api/v1' . $path);
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_CUSTOMREQUEST => $method,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $key,
            'Content-Type: application/json',
            'Accept-Language: ru',
        ],
        CURLOPT_POSTFIELDS => $data !== null ? json_encode($data) : null,
    ]);
    $res = json_decode(curl_exec($ch), true);
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);
    if (($res['ok'] ?? false) !== true) {
        throw new RuntimeException($res['error']['code'] ?? ('http_' . $code));
    }
    return $res;
}

$project = pp_api('POST', '/projects', ['name' => 'Client', 'url' => 'https://client-site.com']);
try {
    $run = pp_api('POST', '/promotion/runs', [
        'project_id' => $project['project']['id'],
        'url' => 'https://client-site.com/services',
    ]);
    echo "Iniciado, run_id={$run['run_id']}, cobrado {$run['charged']}";
} catch (RuntimeException $e) {
    if ($e->getMessage() === 'insufficient_funds') {
        // recarga el saldo y vuelve a intentarlo
    }
}

Python

import os, requests

API = "https://promopilot.link/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['PROMOPILOT_API_KEY']}"}

def api(method, path, **json_body):
    r = requests.request(method, API + path, headers=HEADERS, json=json_body or None, timeout=30)
    data = r.json()
    if not data.get("ok"):
        code = data.get("error", {}).get("code", f"http_{r.status_code}")
        if code == "insufficient_funds":
            details = data["error"]["details"]
            raise RuntimeError(f"Recarga tu saldo: te faltan {details['shortfall']}")
        raise RuntimeError(code)
    return data

project = api("POST", "/projects", name="Client", url="https://client-site.com")
run = api("POST", "/promotion/runs", project_id=project["project"]["id"],
          url="https://client-site.com/services")
print("run_id:", run["run_id"], "charged:", run["charged"])

# Consulta del estado (polling)
import time
while True:
    st = api("GET", f"/promotion/runs/{run['run_id']}")["run"]
    print(st["status"], st["progress"]["pct"], "%")
    if st["status"] in ("completed", "failed", "cancelled"):
        break
    time.sleep(60)

report = api("GET", f"/promotion/runs/{run['run_id']}/report")

Node.js

const API = "https://promopilot.link/api/v1";
const KEY = process.env.PROMOPILOT_API_KEY;

async function api(method, path, body) {
  const res = await fetch(API + path, {
    method,
    headers: {
      "Authorization": `Bearer ${KEY}`,
      "Content-Type": "application/json",
      "Accept-Language": "ru",
    },
    body: body ? JSON.stringify(body) : undefined,
  });
  const data = await res.json();
  if (!data.ok) {
    const code = data.error?.code || `http_${res.status}`;
    if (code === "insufficient_funds") {
      console.error("Recarga tu saldo:", data.error.details.topup_url);
    }
    throw new Error(code);
  }
  return data;
}

const { project } = await api("POST", "/projects", { name: "Client", url: "https://client-site.com" });
const run = await api("POST", "/promotion/runs", { project_id: project.id, url: "https://client-site.com/services" });
console.log("run:", run.run_id, "charged:", run.charged);

OpenAPI

La especificación completa legible por máquina para generar clientes e importarla en Postman/Insomnia: https://promopilot.link/api/v1/openapi.json

Las preguntas y sugerencias sobre la API se gestionan a través del soporte en el panel o en Telegram. Compatibilidad hacia atrás: los cambios incompatibles se publican solo como una nueva versión (/api/v2), y los campos actuales nunca se eliminan sin un aviso en el registro de cambios.