Skip to content

Visão geral da API

Este artigo de referência aborda os conceitos básicos da API, incluindo a terminologia comum e uma visão geral das chaves da API REST, permissões e como mantê-las seguras.

Coleção da API do Braze REST

Definições da API

A seguir, uma visão geral dos termos que você poderá ver na documentação da Braze REST API.

Endpoints

A Braze gerencia várias instâncias diferentes para nosso dashboard e endpoints REST. Quando sua conta for provisionada, você fará o registro em um dos seguintes URLs. Use o endpoint REST correto com base na instância para a qual você está provisionado. Se não tiver certeza, abra um [ticket de suporte][suporte] ou use a tabela a seguir para fazer a correspondência entre o URL do dashboard que você usa e o endpoint REST correto.

Limites da API

Para a maioria das APIs, a Braze tem um limite de frequência padrão de 250.000 solicitações por hora. No entanto, determinados tipos de solicitação têm seu próprio limite de frequência aplicado para lidar melhor com grandes volumes de dados de nossa base de clientes. Para obter informações, consulte os limites de frequência da API

IDs de usuário

  • ID de usuário externo: O endereço external_id serve como um identificador exclusivo do usuário para o qual você está enviando dados. Esse identificador deve ser o mesmo que você definiu no SDK do Braze para evitar a criação de vários perfis para o mesmo usuário.
  • Braze user ID: braze_id serve como um identificador de usuário exclusivo que é definido pela Braze. Esse identificador pode ser usado para excluir usuários por meio da API REST, além de external_ids.

Para saber mais, consulte os seguintes artigos com base em sua plataforma: iOS, Android e Web.

Sobre as chaves da API REST

Uma chave de interface de programação de aplicativo REST (chave de API REST) é um código exclusivo que é passado para uma API para autenticar a chamada de API e identificar o aplicativo ou o usuário que está fazendo a chamada. O acesso à API é feito usando solicitações da Web HTTPS para o endpoint da API REST de sua empresa. Usamos as chaves da API REST no Braze em conjunto com as chaves do App Identifier para rastrear, acessar, enviar, exportar e analisar dados para ajudar a garantir que tudo esteja funcionando sem problemas, tanto do seu lado quanto do nosso.

Os espaços de trabalho e as chaves de API andam de mãos dadas no Braze. Os espaços de trabalho são projetados para abrigar versões do mesmo aplicativo em várias plataformas. Muitos clientes também usam espaços de trabalho para conter versões gratuitas e premium de seus aplicativos na mesma plataforma. Como você pode notar, esses espaços de trabalho também estão usando a API REST e têm suas próprias chaves de API REST. Estas chaves podem ter escopo individual para incluir acesso a endpoints específicos na API. Cada chamada para a API precisa incluir uma chave com acesso ao endpoint atingido.

Referimo-nos tanto à chave da API REST quanto à chave da API do espaço de trabalho como api_key. O api_key é incluído em cada solicitação como um cabeçalho de solicitação e atua como uma chave de autenticação que lhe permite usar nossas APIs REST. Essas APIs REST são usadas para rastrear usuários, enviar mensagens, exportar dados de usuários e muito mais. Ao criar uma nova chave da API REST, você precisará dar a ela acesso a endpoints específicos. Ao atribuir permissões específicas a uma chave de API, você pode limitar exatamente quais chamadas uma chave de API pode autenticar.

![Painel de chaves da API REST na guia Chaves da API.][27]

Criação de chaves da API REST

Para criar uma nova chave da API REST:

  1. Acesse Configurações > APIs e identificadores.

2. Selecione Create API Key (Criar chave de API). 3. Dê um nome à sua nova chave para identificá-la rapidamente. 4. Especifique endereços de IP na lista de permissões e subredes para a nova chave. 5. Selecione as permissões que deseja associar à sua nova chave.

Permissões de chave de API REST

As permissões de chave de API são permissões que podem ser atribuídas a um usuário ou grupo para limitar seu acesso a determinadas chamadas de API. Para visualizar sua lista de permissões de chave de API, acesse Settings > APIs and Identifiers( Configurações > APIs e identificadores) e selecione sua chave de API.

Gerenciamento de chaves da API REST

É possível visualizar detalhes ou excluir chaves de API REST existentes na guia Configurações > APIs e identificadores > Chaves de API. Observe que as chaves da API REST não podem ser editadas depois de criadas.

A guia Chaves de API inclui as seguintes informações para cada chave:

Para visualizar os detalhes de uma chave de API, passe o mouse sobre a chave e selecione View. Isso inclui todas as permissões que essa chave tem, IPs na lista de permissões (se houver) e se essa chave foi aceita na lista de permissões de IP do Braze.

![][30]

Note que, ao excluir um usuário, as chaves de API associadas que o usuário criou não serão excluídas. Para excluir uma chave, passe o mouse sobre a chave e selecione Delete.

![][29]{: style=”max-width:30%;”}

Segurança da chave da API REST

As chaves de API são usadas para autenticar uma chamada de API. Ao criar uma nova chave da API REST, você precisa dar a ela acesso a endpoints específicos. Ao atribuir permissões específicas a uma chave de API, você pode limitar exatamente quais chamadas uma chave de API pode autenticar.

Como as chaves da API REST permitem o acesso a endpoints da API REST potencialmente confidenciais, proteja essas chaves e compartilhe-as apenas com parceiros confiáveis. Elas nunca devem ser expostas publicamente. Por exemplo, não use essa chave para fazer chamadas AJAX em seu site nem a exponha de qualquer outra forma pública.

Uma boa prática de segurança é atribuir a um usuário apenas o acesso necessário para concluir seu trabalho: esse princípio também pode ser aplicado às chaves de API atribuindo permissões a cada chave. Essas permissões proporcionam mais segurança e controle sobre as diferentes áreas da sua conta.

Se ocorrer a exposição acidental de uma chave, ela poderá ser excluída do console de desenvolvedor. Para obter ajuda com esse processo, abra um [tíquete de suporte][suporte].

Lista de permissões de IP da API

Para maior segurança, você pode especificar uma lista de endereços IP e sub-redes que têm permissão para fazer solicitações de API REST para uma determinada chave de API REST. Isso é chamado de lista de permissões. Para permitir endereços IP ou sub-redes específicos, adicione-os à seção Lista de permissões de IPs ao criar uma nova chave da API REST:

Opção para permitir a lista de IPs ao criar uma chave de API.

Se você não especificar nenhum, as solicitações poderão ser enviadas de qualquer endereço IP.

Recursos adicionais

Biblioteca de cliente Ruby

Se estiver implementando a Braze usando Ruby, poderá usar nossa biblioteca de cliente Ruby para reduzir o tempo de importação de dados. Uma biblioteca de cliente é uma coleção de códigos específicos de uma linguagem de programação - neste caso, Ruby - que facilita o uso de uma API.

A biblioteca do cliente Ruby é compatível com os pontos de extremidade do usuário.

[support]: /docs/pt-br/braze_support/ [28]: /docs/pt-br/assets/img_archive/create-new-key.png?c946be26e03a7d399c1ee05bbbf811d9 [29]: /docs/pt-br/assets/img_archive/api-key-options.png?8ed31146d679baf4a4a5974ad8c17923 [27]: /docs/pt-br/assets/img_archive/rest-api-key.png?842dc6972dfb265bb1753e6f4f1b138f [30]: /docs/pt-br/assets/img_archive/view-api-key.png?3d0fa48c855271f5f64687315bc1c955

Github   Editar esta página no GitHub
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!