Skip to content

Criar chave de Autenticação do SDK

post

/app_group/sdk_authentication/create

Use este endpoint para criar uma nova chave de Autenticação do SDK para seu app.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão sdk_authentication.create.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Corpo da solicitação

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 solicitação

Parâmetro Obrigatória Tipo de dados Descrição
app_id Obrigatória String O identificador de API do app.
rsa_public_key_str Obrigatória String A string da chave pública RSA. Deve ser uma chave pública RSA válida ou retornará um erro.
description Obrigatória String Descrição da chave de Autenticação do SDK.
make_primary Opcional booleano Se definido como true, esta chave será a chave de Autenticação do SDK principal quando for criada.

Exemplo de solicitação

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
}'

Resposta

1
2
3

{
  "id": "key id"
}

Parâmetros de resposta

Parâmetro Tipo de dados Descrição
id String O ID da nova chave de Autenticação do SDK criada.

Regras de validação

Este endpoint possui as seguintes regras de validação:

  • Você pode ter até 3 chaves de Autenticação do SDK por app.
  • A string da chave pública RSA deve ser uma chave pública RSA válida no formato adequado.
  • O app_id deve ser um identificador de API do app válido.
  • A descrição não pode estar vazia.
New Stuff!