Claves de API

Stripe autentica tus solicitudes de API con las claves de API de tu cuenta. Si una solicitud no incluye una clave válida, Stripe muestra un error de solicitud no válida. Si una solicitud incluye una clave eliminada o vencida, Stripe muestra 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, selecciona la pestaña Claves de API en tu Dashboard.

Modo de prueba versus modo activo

Todas las solicitudes de API de Stripe se realizan en el modo de prueba o en el modo activo. Usa el modo 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 en un modo no son accesibles en el otro. Por ejemplo, en el modo de prueba un objeto Product no puede formar parte de un pago en el modo activo.

Claves secretas y publicables

Por defecto, todas las cuentas tienen un total de cuatro claves de API: dos para el modo de prueba y dos para el modo activo.

• Clave secreta del modo de prueba: usa esta clave para autenticar solicitudes en tu servidor cuando esté en modo de prueba. De forma predeterminada, puedes usar esta clave para realizar cualquier solicitud de API sin restricciones.
• Clave publicable del modo de prueba: usa esta clave para realizar pruebas en el código del lado del cliente de tu aplicación web o para dispositivos móviles.
• Clave secreta del modo activo: usa esta clave para autenticar solicitudes en tu servidor cuando esté en modo activo. De forma predeterminada, puedes usar esta clave para realizar cualquier solicitud de API sin restricciones.
• Clave publicable del modo activo: cuanto tengas todo listo para lanzar tu aplicación, usa esta clave en el código del lado del cliente de tu aplicación web o para dispositivos móviles.

You can find your secret and publishable keys in API keys. When you’re logged in, Stripe’s documentation automatically populates code examples with your test mode 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. 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.

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

Protege tus claves

Cualquier persona puede usar tu clave de API secreta en el modo activo para realizar una llamada API en nombre de tu cuenta, como crear un cargo o realizar un reembolso. Mantén tus claves seguras con las prácticas recomendadas de las claves secretas de la API.

Personaliza el acceso a la API con claves de API restringidas

Para proporcionar acceso limitado a la API, crea claves de API restringidas. Puedes configurar una clave de API restringida para permitir el acceso de lectura o escritura a recursos de API específicos. Cuando uses microservicios que interactúen con la API en tu nombre, define claves restringidas que permitan solo el acceso mínimo que requieren esos microservicios. Por ejemplo, si usas un servicio de monitoreo de disputas, crea una clave restringida que solo proporcione acceso de lectura a los recursos relacionados con las disputas. Esa clave permite que el servicio obtenga los datos que necesita, pero no le permite realizar ningún cambio ni acceder a ningún otro dato.

Las claves restringidas no pueden interactuar con muchas partes de la API de Stripe, ya que solo tienen el objetivo de disminuir el riesgo cuando se usan o se crean microservicios. No uses claves restringidas como alternativa a las claves de API secretas o publicables de tu cuenta durante el desarrollo de tu integración con Stripe.

Limita las direcciones IP que puedan enviar solicitudes de API

Puedes aumentar la seguridad de una clave secreta o restringida si limitas las direcciones IP que puedan usarla para enviar solicitudes de API. Además, puedes restringir una clave a una o más direcciones IP o a un rango de direcciones IP.

Revela una clave de API secreta para el modo de prueba

En el modo de prueba, puedes revelar una clave de API secreta todas las veces que quieras.

Para revelar una clave secreta en el modo de prueba, haz lo siguiente:

1. En el Dashboard para desarrolladores, selecciona la pestaña claves de API.
2. En la lista Claves estándar, en la fila Clave secreta, haz clic en Revelar clave de prueba.
3. Haz clic en el valor de la clave para copiarlo.
4. Guarda el valor de la clave.
5. Haz clic en Ocultar clave de prueba.

Revela una clave de API secreta o restringida para el modo activo

Por motivos de seguridad, Stripe te muestra una clave de API secreta o restringida solo una vez en el modo activo. Guarda la clave en un lugar seguro donde no la pierdas. Para ayudarte a recordar dónde la guardaste, puedes dejar una nota en la clave en el Dashboard. Si pierdes la clave, puedes cambiarla o eliminarla y crear otra.

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

1. En el Dashboard para desarrolladores, selecciona la pestaña claves de API.
2. En la lista Claves estándar o en la lista Claves restringidas, en la fila correspondiente a la clave que deseas revelar, haz clic en Revelar clave activa.
3. Haz clic en el valor de la clave para copiarlo.
4. Guarda el valor de la clave.
5. Haz clic en Ocultar clave de prueba.
6. Haz clic en el menú de contenido adicional () junto a la clave y, luego, selecciona Editar clave….
7. En el campo Nota, ingresa la ubicación donde guardaste la clave y, luego, haz clic en Guardar.
8. Si creaste la clave antes de que Stripe agregara esta funcionalidad, haz clic en Ocultar clave activa.

Cambia una clave de API

Cuando se cambia una clave, esta se revoca y se genera otra de reemplazo. Puedes cambiar una clave en el momento o programar su cambio pasado determinado tiempo. Es necesario cambiar la clave en escenarios como los siguientes:

• Si estás en modo activo y pierdes una clave secreta o restringida, no puedes recuperarla desde el Dashboard y tienes que reemplazarla.
• Si una clave secreta o restringida se ve comprometida, tienes que revocarla para bloquear las solicitudes de API potencialmente maliciosas que puedan usarla.
• Tu política requiere cambiar las claves cada cierto período de tiempo.

Para cambiar una clave de API, haz lo siguiente:

1. Abre la página de claves de API.
2. En la fila de la clave que deseas cambiar, haz clic en el menú de contenido adicional (), luego selecciona Cambiar clave….
3. Elige una fecha de vencimiento en el menú desplegable Vencimiento.
4. Haz click en Cambiar clave de API.
5. El cuadro de diálogo muestra el nuevo valor de la clave. Haz clic en él para copiarlo.
6. Guarda el valor de la clave. No puedes recuperarlo más tarde.
7. En el campo Agregar una nota, ingresa la ubicación donde guardaste la clave y haz clic en Listo o Guardar.

Si seleccionas Ahora para el Vencimiento, eliminaremos la clave anterior. Si seleccionaste un momento diferente, podrás ver el tiempo que queda hasta el vencimiento de la clave debajo de su nombre.

Independientemente de cuándo vencía la clave anterior, la nueva puede usarse de inmediato.

Cuando cambias una clave publicable, el nombre de la clave de reemplazo es siempre Publishable key. Cuando cambias una clave secreta, el nombre de la clave de reemplazo es siempre Secret key. Cuando cambias una clave restringida, el nombre de la clave de reemplazo es el mismo que el de la que se cambió. Para cambiar el nombre de una clave secreta o restringida, haz clic en su menú de contenido adicional y selecciona Editar clave….

Elimina una clave de API secreta o restringida

Si eliminas una clave, todos los códigos que usen esa clave ya no podrán realizar llamadas API. Crea una nueva clave y actualiza el código para usarla.

Para eliminar una clave, haz lo siguiente:

1. En el Dashboard para desarrolladores, selecciona 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 ícono del menú de contenido adicional () en la fila de esa clave y, luego, selecciona Eliminar clave….
3. Si confirmas que deseas eliminar la clave, en el cuadro de diálogo Eliminar clave de API, haz clic en Eliminar clave. De lo contrario, haz clic en Cancelar.

Crea una clave de API secreta

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

1. Abre la página de claves de API.
2. Haz click en **Crear clave secreta **.
3. Stripe envía un código de verificación a tu dirección de correo electrónico o mediante un mensaje de texto. (Como sucede con cualquier correo electrónico o mensaje de texto, es posible que no llegue de inmediato). Ingresa el código en el cuadro de diálogo. Si el cuadro de diálogo no continúa automáticamente, haz clic en Continuar.
4. Ingresa un nombre en el campo Nombre de la clave.
5. Haz click en Crear.
6. El cuadro de diálogo muestra el nuevo valor de la clave. Haz clic en él para copiarlo.
7. Guarda el valor de la clave. No puedes recuperarlo más tarde.
8. En el campo Agregar una nota, ingresa la ubicación donde guardaste la clave y haz clic en Listo.

Crea 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. Abre la página de claves de API.
2. Puedes crear una clave restringida desde cero o comenzar por clonar una clave restringida que ya existe.
   • 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 que ya existe, en la fila de la clave que deseas clonar, haz clic en el menú de contenido adicional () y, a continuación, selecciona Duplicar clave…. En este caso, el valor predeterminado para cada permiso es su valor en la clave clonada.
3. En el campo Nombre de la clave, ingresa un nombre. Si clonaste una clave existente, el nombre predeterminado es el nombre de la clave clonada.
4. Para cada recurso al que deseas que acceda la nueva clave, selecciona el permiso para que esta clave lo permita. Si usas Connect, también puedes seleccionar el permiso para que esta clave lo permita cuando se acceda a las cuentas conectadas. Los permisos disponibles son Ninguno, Lectura o Escritura.
5. Haz click en Crear clave.
6. Stripe envía un código de verificación a tu dirección de correo electrónico o mediante un mensaje de texto. (Como sucede con cualquier correo electrónico o mensaje de texto, es posible que no llegue de inmediato). Ingresa el código en el cuadro de diálogo. Si el cuadro de diálogo no continúa automáticamente, haz clic en Continuar.
7. El cuadro de diálogo muestra el nuevo valor de la clave. Haz clic en él para copiarlo.
8. Guarda el valor de la clave. No puedes recuperarlo más tarde.
9. En el campo Agregar una nota, ingresa la ubicación donde guardaste la clave y haz clic en Listo.

Limita las claves secretas o restringidas a una lista o rango de direcciones IP

Para limitar las solicitudes de API con una clave a una o más direcciones IP específicas o a un rango de direcciones IP, ten en cuenta lo siguiente:

1. Abre la página de claves de API.
2. En la lista Claves estándar o en la lista Claves restringidas, en la fila correspondiente a la clave que deseas revelar, haz clic en el menú de contenido adicional () y, a continuación, selecciona Administrar restricciones de IP….
3. Haz clic en Limitar el uso a un conjunto de direcciones IP.
4. Introduce una dirección o intervalo de direcciones IP:
   • Introduce una dirección IP individual en el campo Dirección IP.
   • Introudce el rango de direcciones IP en la notación de enrutamiento entre dominios sin clases (CIDR). En el campo Dirección IP, introduce la primera dirección del rango. En el campo CIDR, introduce el tamaño del prefijo de red.
   • También puedes seleccionar la pestaña Administrar de manera masiva e introducir direcciones IP individuales y rangos de direcciones IP, separados por espacios. Los cambios que realices en una pestaña aparecerán en la otra pestaña.
5. Para agregar otra dirección o rango, haz clic en + Agregar.
6. Haz click en Guardar.

Cambia 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. Abre la página de claves de API.
2. En la fila de la clave que deseas cambiar, haz clic en el menú de contenido adicional () y selecciona Editar clave….
3. Si deseas cambiar el nombre, ingresa el nuevo en Nombre de la clave.
4. Si deseas cambiar el texto de la nota, ingresa el nuevo texto en Nota.
5. Haz click en Guardar.

Visualiza los registros de solicitudes de API

Para abrir los registros de solicitudes de API, haz clic en el menú de contenido adicional () de una clave y, luego, selecciona Ver registros de solicitudes. Si abres los registros, irás al Dashboard principal de Stripe.