Claves de API

Stripe autentica tus peticiones de API usando las claves de API de tu cuenta. Si una petición no incluye ninguna clave válida, Stripe devuelve un error de petición no válida. Si una petición incluye una clave eliminada o caducada, Stripe devuelve un error de autenticación.

Usa el Dashboard de desarrolladores para crear, revelar, eliminar y cambiar claves de API. Para acceder a tus claves de API v1, elige la pestaña Claves de API en tu Dashboard.

Tipos de claves

By default, all accounts have a total of four API keys, two in a sandbox and two in live mode:

• Sandbox secret key: Use this key to authenticate requests on your server when you’re testing in a sandbox. By default, you can use this key to perform any API request without restriction. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• Sandbox publishable key: Use this key for testing purposes in your web or mobile app’s client-side code. Reserve this key for testing and development to make sure that you don’t accidentally modify your live customers or charges.
• Clave secreta en modo activo: usa esta clave para autenticar peticiones en tu servidor cuando estés en modo activo. De forma predeterminada, puedes usar esta clave para realizar cualquier petición de API sin restricciones.
• Clave publicable en modo activo: usa esta clave cuando estés listo para lanzar tu aplicación en el código del lado cliente de tu aplicación web o móvil.

Your secret and publishable keys are in the Dashboard in the API keys tab. If you can’t view your API keys, ask the owner of your Stripe account to add you to their team with the proper permissions.

When you’re logged in to Stripe, our documentation automatically populates code examples with your test API keys. Only you can see these values. If you’re not logged in, our code examples include randomly generated API keys. You can replace them with your own test keys or log in to see the code examples populated with your test API keys.

La siguiente tabla muestra ejemplos generados aleatoriamente de claves de API de prueba secretas y publicables:

Entorno de prueba frente a modo activo

Todas las peticiones de API de Stripe tienen lugar en un entorno de prueba o en modo activo. Utiliza un entorno de prueba para acceder a los datos de prueba y el modo activo para acceder a los datos de la cuenta real. Cada modo tiene su propio conjunto de claves de API. Los objetos de un modo no son accesibles en el otro. Por ejemplo, un objeto de producto de un entorno de prueba no puede formar parte de un pago en modo activo.

Rotar una clave API

Cuando se rota una clave, esta se revoca y se genera otra de reemplazo. Puedes rotar una clave inmediatamente o programar una clave para que rote después de un cierto tiempo. Rota una clave en situaciones como las que siguen a continuación:

• Si estás en modo activo y pierdes una clave secreta o restringida, no podrás recuperarla desde el Dashboard y deberás reemplazarla.
• Si una clave secreta o restringida se ve comprometida, debes revocarla para bloquear cualquier petición de API potencialmente maliciosa que pueda usarla.
• Tu política requiere que se cambien las claves en intervalos determinados.

Para rotar una clave API haz lo siguiente:

1. Abra la página de claves de API.
2. En la fila de la clave que quieres rotar, haz clic en el menú de desbordamiento () y selecciona Rotar clave.
3. Elige una fecha de caducidad en el menú desplegable Caducidad.
4. Haz clic en Rotar clave API.
5. El cuadro de diálogo muestra el nuevo valor de la clave. Para copiarlo, haz clic en él.
6. Guarda el valor de la clave. No podrás recuperarlo más tarde.
7. En el campo Añadir una nota, introduce la ubicación donde has guardado la clave y haz clic en Listo o Guardar.

Si eliges Ahora para la Caducidad, eliminaremos la clave anterior. Si has elegido otro momento, podrás ver el tiempo restante hasta que la clave expire debajo de su nombre.

Independientemente del tiempo de caducidad de la clave anterior, la nueva clave estará lista para usarse de inmediato.

Cuando rotas una clave publicable, el nombre de la clave de reemplazo siempre es Publishable key. Cuando rotas una clave secreta, el nombre de la clave de reemplazo siempre es Secret key. Cuando rotas una clave restringida, el nombre de la clave de reemplazo es el mismo que el de la clave rotada. Puedes cambiar el nombre de una clave secreta o restringida haciendo clic en su menú desplegable y seleccionando Editar clave.

Cómo ver los registros de las peticiones de API

Para abrir los registros de peticiones de API, haz clic en el menú de desbordamiento () de cualquier clave y, a continuación, elige Ver registros de peticiones. Al abrir los registros, regresarás al Dashboard principal de Stripe.

Claves secretas y restringidas

Utiliza el Dashboard para crear, eliminar, revelar y modificar claves secretas y restringidas.

Cómo crear una clave de API secreta

Para crear una clave de API secreta, haz lo siguiente:

1. Abra la página de claves de API.
2. Haz clic en Crear clave secreta.
3. Stripe envía un código de verificación a tu dirección de correo electrónico o en un mensaje de texto. (Al igual que con cualquier correo electrónico o mensaje de texto, es posible que no llegue de inmediato). Introduce el código en el cuadro de diálogo. Si el cuadro de diálogo no continúa de manera automática, haz clic en Continuar.
4. Introduce un nombre en el campo Nombre de la clave.
5. Haz clic en Crear.
6. El cuadro de diálogo muestra el nuevo valor de la clave. Para copiarlo, haz clic en él.
7. Guarda el valor de la clave. No podrás recuperarlo más tarde.
8. En el campo Añadir una nota, introduce la ubicación donde has guardado la clave y haz clic en Listo.

Cómo crear una clave de API restringida

Una clave de API restringida solo permite el nivel de acceso que especifiques.

Para crear una clave de API restringida, haz lo siguiente:

1. Abra la página de claves de API.
2. Puedes crear una clave restringida desde cero o comenzar por clonar una clave restringida existente.
   • Para crear una clave restringida desde cero, haz clic en Crear clave restringida. En este caso, el valor predeterminado para todos los permisos es Ninguno.
   • Para clonar una clave existente, haz clic en el menú de desbordamiento () y selecciona Duplicar clave en la fila correspondiente a la clave que deseas clonar. En este caso, el valor predeterminado para cada permiso es su valor en la clave clonada.
3. En el campo Nombre de clave, introduce un nombre. Si has clonado una clave existente, el nombre predeterminado es el nombre de la clave clonada.
4. Para cada recurso al que quieras que acceda la nueva clave, selecciona el permiso que quieres permitir para la clave. Si utilizas Connect, también puedes seleccionar el permiso que se aplicará a esta clave al acceder a cuentas conectadas. Los permisos disponibles son Ninguno, Lectura o Escritura.
5. Haz clic en Crear clave.
6. Stripe envía un código de verificación a tu dirección de correo electrónico o en un mensaje de texto. (Al igual que con cualquier correo electrónico o mensaje de texto, es posible que no llegue de inmediato). Introduce el código en el cuadro de diálogo. Si el cuadro de diálogo no continúa de manera automática, haz clic en Continuar.
7. El cuadro de diálogo muestra el nuevo valor de la clave. Para copiarlo, haz clic en él.
8. Guarda el valor de la clave. No podrás recuperarlo más tarde.
9. En el campo Añadir una nota, introduce la ubicación donde has guardado la clave y haz clic en Listo.

Cómo eliminar una clave de API secreta o restringida

Si eliminas una clave, cualquier código que utilice esa clave ya no podrá hacer llamadas a la API. Después de eliminar una clave, crea una nueva y actualiza el código para usarla.

Para eliminar una clave, haz lo siguiente:

1. En el Dashboard de desarrolladores, elige la pestaña Claves de API.
2. Busca la clave que deseas eliminar en la lista Claves estándar o Claves restringidas. Haz clic en el menú de desbordamiento () en la fila de esa clave y, a continuación, elige Eliminar clave.
3. Si estás seguro de que deseas eliminar la clave, haz clic en Eliminar clave en el cuadro de diálogo Eliminar clave de API. De lo contrario, haz clic en Cancelar.

Revela una clave de API secreta en un entorno de prueba

Con los entornos de prueba, puedes revelar una clave de API secreta tantas veces como quieras.

Para revelar una clave secreta en un entorno de prueba, haz lo siguiente:

1. En el Dashboard de desarrolladores, elige la pestaña Claves de API.
2. En la lista Claves estándar, haz clic en Revelar clave de prueba en la fila Clave secreta.
3. Para copiar el valor de la clave, haz clic en él.
4. Guarda el valor de la clave.
5. Haz clic en Ocultar clave de prueba.

Cómo revelar una clave de API secreta o restringida para el modo activo

En modo activo, Stripe solo te muestra una clave de API secreta o restringida una vez (por motivos de seguridad). Guarda la clave en un lugar donde no la pierdas. Para ayudarte a recordar dónde la has almacenado, puedes dejar una nota sobre la clave en el Dashboard. Si pierdes la clave, puedes rotarla o eliminarla y crear otra.

Para revelar una clave secreta o restringida en modo activo y adjuntar una nota, haz lo siguiente:

1. En el Dashboard de desarrolladores, elige la pestaña Claves de API.
2. Haz clic en Revelar clave activa en la lista Claves estándar o en la lista Claves restringidas en la fila correspondiente a la clave que quieres mostrar.
3. Para copiar el valor de la clave, haz clic en él.
4. Guarda el valor de la clave.
5. Haz clic en Ocultar clave de prueba.
6. Haz clic en el menú de desbordamiento () ubicado junto a la clave y elige Editar clave.
7. En el campo Nota, introduce la ubicación donde guardaste la clave y haz clic en Guardar.
8. Si has creado la clave antes de que Stripe incorporara esta función, haz clic en Ocultar clave activa.

Cómo limitar las claves secretas o restringidas a una lista o un rango de direcciones IP

Para limitar las peticiones de API que usan una clave a una o varias direcciones IP específicas o a un rango de direcciones IP, haz lo siguiente:

1. Abra la página de claves de API.
2. Haz clic en el menú de desbordamiento () en la lista Claves estándar o en la lista Claves restringidas en la fila correspondiente a la clave que deseas mostrar y selecciona Administrar restricciones de IP.
3. Haz clic en **Limitar el uso a un conjunto de direcciones IP **.
4. Introduce una dirección IP o un rango de direcciones IP:
   • En el caso de una dirección IP individual, introdúzcala en el campo Dirección IP.
   • Para un rango de direcciones IP, introduce el rango en la notación de enrutamiento entre dominios sin clases (CIDR). En el campo Dirección IP, introduce la primera dirección en el rango. En el campo CIDR, introduce el tamaño del prefijo de red.
   • También puedes seleccionar la pestaña Gestionar de forma masiva e introducir direcciones IP individuales y rangos, separados por espacios. Los cambios que realices en una pestaña se harán también en la otra pestaña.
5. Para añadir otra dirección o intervalo, haz clic en + Añadir.
6. Haz clic en Guardar.

Cómo cambiar el nombre o la nota de una clave de API secreta o restringida

Para cambiar el nombre o el texto de la nota de una clave secreta o restringida, haz lo siguiente:

1. Abra la página de claves de API.
2. Haz clic en el menú de desbordamiento () en la fila de la clave que deseas cambiar y selecciona Editar clave.
3. Si deseas cambiar el nombre, introduce el nuevo nombre en Nombre de la clave.
4. Si deseas cambiar el texto de la nota, en Nota, introduce el nuevo texto de la nota.
5. Haz clic en Guardar.

Protege tus claves

Cualquier persona puede usar tu clave secreta de API en modo activo para realizar cualquier llamada a la API en nombre de tu cuenta, como crear un cargo o realizar un reembolso. Para mantener seguras tus claves, sigue las mejores prácticas de claves secretas de API.