Skip to content

Crear clave de autenticación SDK

post

/app_group/sdk_authentication/create

Utiliza este punto de conexión para crear una nueva clave de autenticación SDK para tu aplicación.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso sdk_authentication.create.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto de conexión, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6

{
  "app_id": "App API identifier",
  "rsa_public_key_str": "RSA public key string",
  "description": "description",
  "make_primary": false
}

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
app_id Obligatorio Cadena El identificador de API de la aplicación.
rsa_public_key_str Obligatorio Cadena La cadena de clave pública RSA. Debe ser una clave pública RSA válida o devolverá un error.
description Obligatorio Cadena Descripción de la clave de autenticación SDK.
make_primary Opcional Booleano Si se establece en true, esta clave se convertirá en la clave de autenticación SDK principal cuando se cree.

Ejemplo de solicitud

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/app_group/sdk_authentication/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "app_id": "01234567-89ab-cdef-0123-456789abcdef",
  "rsa_public_key_str": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvD+fgA0YuCUd/v35htn...\n-----END PUBLIC KEY-----",
  "description": "SDK Authentication Key for iOS App",
  "make_primary": false
}'

Respuesta

1
2
3

{
  "id": "key id"
}

Parámetros de respuesta

Parámetro Tipo de datos Descripción
id Cadena El ID de la clave de autenticación SDK recién creada.

Reglas de validación

Este punto de conexión tiene las siguientes reglas de validación:

  • Puedes tener hasta 3 claves de autenticación SDK por aplicación.
  • La cadena de clave pública RSA debe ser una clave pública RSA válida con el formato adecuado.
  • El app_id debe ser un identificador de API de aplicación válido.
  • La descripción no puede estar vacía.
New Stuff!