Aprende a crear claves y tokens de API para administrar la configuración de tu cuenta de Cloudflare.

Información general

La API de Cloudflare expone todas las funciones de Cloudflare a través de una interfaz programática. Puedes administrar la configuración de tu cuenta, configurar productos y desarrollar aplicaciones utilizando la API de Cloudflare.

Usar la API de Cloudflare requiere un token o una clave de API para autenticar el origen de la solicitud de API. Para obtener más información sobre el proceso de autenticación, revisa la documentación de la API de Cloudflare.

Una clave de API es única para cada usuario de Cloudflare y se usa solo para fines de autenticación. La clave de API no autoriza el acceso a cuentas o zonas. 

Los tokens de API te permiten autorizar el acceso a aplicaciones, cuentas y zonas específicas de Cloudflare con permisos limitados. Cada usuario de Cloudflare puede tener hasta 50 tokens de API asociados a su cuenta de Cloudflare.

Los tokens de API están asociados al usuario que los creó. Si tu cuenta de Cloudflare es invalidada o tus permisos cambian, perderás el acceso a tu token de API.

Cómo generar un token de API

Para generar un token de API:

1. Inicia sesión en el panel de control de Cloudflare.

2. En el menú desplegable Mi perfil, haz clic en Mi perfil.

3. Haz clic en la pestaña Tokens de API. 

4. Haz clic en el botón Crear token. Verás la pantalla  Crear token. 

5. Tienes dos opciones de configuración que puedes seleccionar:

• Haz clic en Empezar en la sección Token personalizado para configurar manualmente la configuración de token deseada. Avanza al paso 6.

• Selecciona Empezar con una plantilla para elegir entre una lista de configuraciones comunes. Elige una plantilla, luego haz clic en Usar plantilla. A continuación, avanza al paso 6.

6. Selecciona los siguientes Permisos de edición o lectura:

• Recursos de cuenta o zona: el token de API incluirá o excluirá tu(s) cuenta(s) o los dominios y subdominios asociados a tu(s) cuenta(s).

7. Selecciona los siguientes Recursos de edición o lectura:

• Cuenta o Zona: el token de API aplicará a tu(s) cuenta(s) o los dominios y subdominios asociados a tu(s) cuenta(s).

8. Haz clic en Ir a resumen.

9. Revisa los detalles del token de API, a continuación haz clic en Crear token para finalizar. Verás un mensaje de confirmación con tu token de API.

10. Haz clic en Copiar para guardar el token de API en tu ordenador. Este token contiene tu clave secreta, así que asegúrate de guardarla en un sitio seguro.

Activar un token de API

Si tu token de API  se ve comprometido o se pierde, puedes crear un nuevo token o activar tu clave secreta en uno nuevo. Este paso autorizará el mismo acceso y permisos que la clave anterior.

Para añadir tu token de API, haz clic en Activar en la sección Tokens de API del panel de control de Cloudflare.

Luego, haz clic en Confirmar para continuar y verás una nueva clave secreta de token de API.

Ver clave de API

Para recuperar tu clave de API:

1. Inicia sesión en el panel de control de Cloudflare.

2. En el menú desplegable Mi perfil, haz clic en Mi perfil.

3. Haz clic en la pestaña Tokens de API. 

4. En la sección Claves de API, elige una de las dos opciones: clave de API global o clave CA de origen. Elige la clave de API que te gustaría ver.

5. Para cambiar tu clave de API, haz clic en Cambiar. Deberás completar un desafío CAPTCHA antes de que el cambio surta efecto.

Principales causas de los problemas relacionados con los token de API

• El token en sí no se verifica

Puedes asegurarte de que el token ha sido verificado ejecutando el siguiente curl y confirmar que la respuesta devuelve " estado": "activo" .

#cURL (ejemplo)
curl -X GET "https://api.cloudflare.com/client/v4/user/tokens/verify" \
-H "Authorization: Bearer " \
-H "Content-Type:application/json"

#Response (ejemplo)
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "f267e341f3dd4697bd3b9f71dd96247f",
    "status": "active",
    "not_before": "2018-07-01T05:20:00Z",
    "expires_on": "2020-01-01T00:00:00Z"
  }

• El token tiene permisos incorrectos

Envíanos una captura de pantalla de los permisos que has configurado para verificar si el permiso se ha configurado correctamente. 

• Sintaxis incorrecta

En ocasiones, los clientes intentarán utilizar un token de API con una sintaxis de clave de API. Asegúrate de que estás utilizando la opción Portador, en lugar del dúo correo electrónico y clave de API.

curl -X GET "https://api.cloudflare.com/client/v4/user/tokens?page=1&per_page=20&direction=desc" \
-H "Authorization: Bearer 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T"

• Permisos de usuario incorrectos al intentar crear un token

Un cliente no puede crear un token para sí mismo que exceda el permiso que se le ha concedido en su cuenta. Por ejemplo, si a un cliente se le ha concedido un rol de Admin (solo lectura), necesitaría que su superadministrador actualizara su rol para poder crear su propio token.

Recursos relacionados

• Documentación de API de Cloudflare