Skip to main content
Cada solicitud a la API de Pioneer requiere una clave de API pasada en el encabezado X-API-Key. Crea claves en el panel de Pioneer y luego utiliza los endpoints de gestión de claves para listar y revocar claves existentes de forma programática.
Guarda las claves de API en variables de entorno en lugar de codificarlas en el código fuente. Por ejemplo, define PIONEER_API_KEY en tu entorno y léelo en tiempo de ejecución. Nunca subas claves de API al control de versiones.

​
Crear una clave de API

POST /create-api-key Genera una nueva clave de API asociada a tu cuenta. Este endpoint lo utiliza el panel de Pioneer y requiere una sesión de navegador. Las llamadas autenticadas con una clave de API existente se rechazan con 403 Forbidden para evitar el encadenamiento de credenciales. Cuerpo de la solicitud
​
string
requerido
Un nombre descriptivo para identificar esta clave. Usa nombres que reflejen el propósito de la clave o el servicio al que pertenece, por ejemplo "ci-pipeline" o "production-inference".
No utilices una clave de API existente para crear otra clave de API. La autenticación con X-API-Key no se acepta para este endpoint; crea claves desde Settings -> API Keys en el panel.
Respuesta
​
string
El valor completo de la clave de API. Esta es la única vez que se devuelve en texto plano. Cópiala inmediatamente y guárdala en un lugar seguro, como un gestor de secretos o una variable de entorno.
​
string
Identificador único de la clave. Usa este ID al revocar la clave.
​
string
El nombre que asignaste a la clave.
​
string
Marca de tiempo en ISO 8601 de cuándo se creó la clave.
​
string
Últimos dígitos de la clave generada, para su visualización e identificación.
​
string | null
Marca de tiempo opcional de expiración en ISO 8601, o null cuando la clave no expira.
​
string
Equipo al que está vinculada la clave.
​
boolean
Indica si Pioneer creó un registro de cliente de Stripe durante la creación de la clave.
El valor completo de la clave solo se devuelve en el momento de la creación. Si lo pierdes, deberás revocar la clave y crear una nueva.

​
Listar claves de API

GET /list-api-keys Devuelve todas las claves de API asociadas a tu cuenta. Los valores de las claves están enmascarados en la respuesta. Solo se devuelven metadatos como el nombre y la fecha de creación.
Respuesta
​
object[]
Array de objetos con metadatos de las claves de API.
​
number
Número de claves devueltas.

​
Revocar una clave de API

DELETE /delete-api-key Revoca permanentemente una clave de API. Cualquier solicitud que utilice la clave revocada recibirá inmediatamente respuestas 401 Unauthorized. Cuerpo de la solicitud
​
string
requerido
El ID único de la clave a revocar, tal como lo devuelve GET /list-api-keys.
Revocar una clave es inmediato e irreversible. Asegúrate de que cualquier servicio que utilice la clave se actualice para usar una clave de reemplazo antes de revocar la antigua, para evitar interrupciones del servicio.
Respuesta Devuelve 200 OK con un cuerpo JSON de éxito.
​
boolean
Indica si la clave fue revocada.
​
string | null
Mensaje de estado legible por humanos.