Postman e solicitações de amostra
A Braze permite que você gere solicitações de API de amostra para todos os nossos endpoints por meio da nossa Coleção Postman. Este artigo de referência aborda a Coleção Postman da Braze, o que ela é, como configurar e usar a coleção, além de como editar e enviar solicitações.
O que é o Postman?
O Postman é uma ferramenta de edição visual gratuita para criar e testar solicitações de API. Em comparação com outros métodos (por exemplo, usando cURL), o Postman permite que você edite solicitações de API, visualize informações de cabeçalho e muito mais. Você pode salvar coleções (bibliotecas de exemplos de solicitações de API pré-fabricadas). Para acelerar a configuração com nossa REST API, fornecemos uma coleção com exemplos pré-fabricados para todos os endpoints.
Visualize ou baixe nossa Coleção do Postman clicando em Run in Postman nos nossos documentos do Postman para começar.
Como usar a coleção Postman da Braze
Se você tiver uma conta no Postman (você pode baixar as versões para macOS, Windows e Linux no site do Postman), pode abrir nossa documentação do Postman no seu próprio app do Postman clicando no botão laranja Run in Postman. Você pode então criar um ambiente, ou usar nosso ambiente da REST API da Braze como modelo, e editar as solicitações POST e GET disponíveis para atender às suas próprias necessidades.
Configurando seu ambiente Postman
A Coleção Postman da Braze usa uma variável de modelo, {{instance_url}}, para substituir a URL da REST API da sua instância da Braze nas solicitações pré-construídas, e a variável {{api_key}} para sua chave de API. Em vez de ter que editar manualmente todas as solicitações na coleção, você pode configurar essa variável no seu ambiente do Postman. Você pode selecionar nosso ambiente modelado (Braze REST API Environment Template) no menu suspenso e substituir os valores das variáveis pelos seus próprios, ou pode configurar seu próprio ambiente.
Para configurar seu próprio ambiente, execute as seguintes etapas:
- Na guia Workspaces, selecione Environments.
- Clique no botão + para criar um novo ambiente.
- Dê um nome a esse ambiente (por exemplo, “Braze API Requests”) e adicione chaves para
instance_urleapi_keycom valores correspondentes à sua instância da Braze e à chave da REST API da Braze. - Clique em Save.
Nos corpos de solicitação POST, o api_key deve ser encapsulado em aspas: "MY-API-KEY-EXAMPLE". Em URLs GET, não deve ser. Já fornecemos essa formatação para você nos corpos de solicitação POST desta documentação, URLs GET e modelo de ambiente para YOUR-API-KEY-HERE.
Usando as solicitações pré-construídas da coleção
Depois de configurar seu ambiente, você pode usar qualquer uma das solicitações pré-construídas na coleção como modelo para criar novas solicitações de API. Para começar a usar uma das solicitações pré-construídas, clique nela no menu Collections do Postman. Isso abrirá a solicitação como uma nova guia na janela principal do app Postman.
Em geral, existem dois tipos de solicitações que os endpoints da API da Braze aceitam: GET e POST. Dependendo de qual método HTTP o endpoint usa, você precisará editar a solicitação pré-construída de forma diferente.
Editar uma solicitação POST
Ao editar uma solicitação POST, abra a solicitação e navegue até a seção Body no editor de solicitações. Para melhor legibilidade, selecione o botão de opção raw para formatar o corpo da solicitação JSON.
Editar uma solicitação GET
Ao editar uma solicitação GET, edite os parâmetros passados na URL da solicitação. Para fazer isso, selecione a guia Params e edite os pares chave-valor nos campos que aparecem.
Envie sua solicitação
Depois que sua solicitação de API estiver pronta, clique em Send. A solicitação é enviada e os dados da resposta são preenchidos em uma seção abaixo do editor de solicitações. A partir daqui, você pode visualizar os dados brutos retornados da API da Braze, ver o código de resposta HTTP, ver quanto tempo a solicitação levou para processar e visualizar as informações do cabeçalho.
