Guía de integración
Conecta tu código a la API REST de Rank Prompt
Lleva tu visibilidad en IA a tus propios paneles y procesos, o corre reportes desde tu backend, con una clave acotada y una API /v1 versionada y documentada en OpenAPI 3.1.
Rank Prompt lee
- Tus solicitudes
- La clave y sus permisos
Rank Prompt envía
- JSON de marcas, reportes y citas
- Headers de cuota
- Errores estructurados
Rank Prompt Qué hace
- Gestiona marcas, prompts, reportes, programaciones, citas, contenido y datos SEO desde tu backend.
- Limita cada clave a los recursos que necesita y, si quieres, a una sola marca.
- Hace que las escrituras se puedan reintentar sin riesgo con un
Idempotency-Key, y deja correr cualquier llamada como vista previa gratis con?dry_run=true. - Publica una spec OpenAPI 3.1 legible por máquinas, con una página de referencia por endpoint.
Antes de empezar
Plan Todos los planes, incluido el gratis
- Un backend o script que pueda guardar un secreto. Las llamadas desde el navegador están bloqueadas: la API es de servidor a servidor.
- Una clave de API de Desarrolladores, Claves de API, que se muestra una sola vez al crearla.
- Sirve cualquier plan, incluido el gratis, con 1.000 solicitudes al mes en Free.
API REST: configuración en 4 pasos
-
Paso 1
Crea una clave
En Rank Prompt, abre Desarrolladores, Claves de API y haz clic en Crear clave.
-
Paso 2
Elige permisos, marca y vencimiento
Dale un nombre que reconozcas, el menor conjunto de permisos que necesite la integración, una marca si solo debe llegar a una y una fecha de vencimiento para las claves que entregas a externos.
-
Paso 3
Guarda la clave en un lugar seguro
La clave completa, que empieza con
rp_live_, se muestra una sola vez. Guárdala en tu gestor de secretos, nunca en código del cliente. -
Paso 4
Haz la primera llamada
Llama a
GET https://api.rankprompt.com/v1/meconAuthorization: Bearery tu clave. Confirma que la clave funciona y en qué cuenta actúa.
API REST: errores y soluciones
Estos son los mensajes que muestra la app, palabra por palabra, y lo que resuelve cada uno.
-
invalid_api_key: API key is invalid or revoked
Revisa que copiaste la clave entera, empezando por
rp_live_, y que no se revocó en Desarrolladores. -
insufficient_scope: API key does not have the required scope
El campo
details.required_scopedel error nombra el permiso que falta. Crea una clave que lo incluya. -
brand_not_authorized: API key is not authorized for this brand
La clave está restringida a otra marca. Usa una clave de esta marca, o una sin restricción de marca.
-
request_quota_exceeded: Monthly request quota exceeded
Se agotaron las solicitudes mensuales del plan. Se renuevan con el período de facturación; los headers de cuota de cada respuesta muestran cuánto queda.
-
browser_calls_forbidden: The Public Developer API is server-to-server only. Browser CORS calls are blocked; call /v1 from your backend with a bearer API key.
Pasa la llamada a tu backend y guarda la clave ahí.
¿La API está incluida en mi plan?
Sí, en todos los planes, incluido el gratis. El plan fija las solicitudes mensuales, desde 1.000 en Free, y las llamadas que hacen trabajo de IA usan los créditos del plan.
¿Dónde está la referencia de la API?
En rankprompt.com/docs/v1, generada desde la misma spec OpenAPI 3.1 que sirve la API, con cada endpoint, permiso, código de error y costo en créditos.
¿Una clave puede llegar solo a la marca de un cliente?
Sí. Restríngela a una marca al crearla, y cualquier solicitud a otra marca responde brand_not_authorized, tenga los permisos que tenga la clave.
¿Y las claves creadas en una cuenta de equipo?
Una clave actúa en la cuenta que estaba activa cuando se creó. GET /v1/me muestra account_id, account_role y account_plan, y la clave deja de funcionar si sales de esa cuenta.
En marcha en pocos minutos
Crea una cuenta gratis, sigue los pasos de arriba y mira qué le suma la conexión a tu visibilidad en IA.