Skip to content

Establecer la clave de autenticación SDK principal

put

/app_group/sdk_authentication/primary

Utiliza este punto de conexión para establecer una clave de autenticación SDK como clave principal para tu aplicación.

Requisitos previos

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

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

{
  "app_id": "App API identifier",
  "key_id": "key id"
}

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.
key_id Obligatorio Cadena El ID de la clave de autenticación SDK que se va a marcar como principal.

Ejemplo de solicitud

1
2
3
4
5
6
7

curl --location --request PUT 'https://rest.iad-01.braze.com/app_group/sdk_authentication/primary' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "app_id": "01234567-89ab-cdef-0123-456789abcdef",
  "key_id": "abcdef12-3456-7890-abcd-ef1234567890"
}'

Respuesta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "keys": [
    {
      "id": "abcdef12-3456-7890-abcd-ef1234567890",
      "rsa_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvD+fgA0YuCUd/v35htn...\n-----END PUBLIC KEY-----",
      "description": "SDK Authentication Key for iOS App",
      "is_primary": true
    },
    {
      "id": "fedcba98-7654-3210-fedc-ba9876543210",
      "rsa_public_key": "-----BEGIN PUBLIC KEY-----\nqWGfHOAiIwVzC/bTxwQZQQVzm/3ktgdNXRUDm5aIwVzCtxbNm5aIxOAiIwVzVHOA...\n-----END PUBLIC KEY-----",
      "description": "SDK Authentication Key for Android App",
      "is_primary": false
    }
  ]
}

Parámetros de respuesta

Parámetro Tipo de datos Descripción
keys Matriz Matriz de todos los objetos de clave de autenticación SDK.
keys[].id Cadena El ID de la clave de autenticación SDK.
keys[].rsa_public_key Cadena La cadena de clave pública RSA.
keys[].description Cadena Descripción de la clave de autenticación SDK.
keys[].is_primary Booleano Si esta clave es la clave de autenticación SDK principal.

Reglas de validación

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

  • El key_id debe ser un ID de clave de autenticación SDK válido.
  • El app_id debe ser un identificador de API de la aplicación válido.
  • La clave de autenticación SDK debe existir para la aplicación especificada.
New Stuff!