Identificadores chave da API

Esta publicação lista os identificadores essenciais usados nas solicitações da API Pushwoosh. Esses identificadores são necessários para autenticação, criação de mensagens, direcionamento, segmentação, rastreamento e gerenciamento de usuários em seus aplicativos.

Identificadores gerais

Código do aplicativo

Um identificador exclusivo atribuído a cada aplicativo em sua conta Pushwoosh. É necessário na maioria das chamadas de API para especificar o aplicativo de destino.

Onde encontrar

Painel de Controle da Pushwoosh → Abaixo do nome do aplicativo.

Token de acesso à API

Um token exclusivo atribuído a uma conta Pushwoosh, usado para autenticar solicitações de API. Ele permite o acesso para gerenciar projetos, enviar mensagens, modificar configurações e recuperar dados. Cada conta tem pelo menos um token criado por padrão. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Acesso à API.

Identificadores de dispositivo

ID de Hardware (HWID)

Um identificador exclusivo atribuído a um dispositivo pelo SDK da Pushwoosh. Definido automaticamente pelo SDK ou passado durante o registro do dispositivo. Saiba mais

Onde encontrar

Nos logs do dispositivo. Saiba mais
No User Explorer ao pesquisar por ID do Usuário
No arquivo CSV baixado da lista de Segmentos

Token de push

Um token emitido pelos provedores de plataforma que identifica um par aplicativo-dispositivo para a entrega de notificações push. Coletado automaticamente pelo SDK quando as permissões de push são concedidas. Saiba mais

Onde encontrar

Nos logs do dispositivo. Saiba mais
No User Explorer, insira o HWID no campo de busca para encontrar o dispositivo associado, depois abra os detalhes do dispositivo para visualizar o token de push.

Tipo de dispositivo

Indica a plataforma do dispositivo de destino usando um código numérico. Definido automaticamente pelo SDK.

Valores suportados:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
14 – Email
17 – Huawei
18 – SMS
21 – WhatsApp
22 – Line

Identificadores de usuário

ID do Usuário

Um identificador personalizado atribuído a um usuário, permitindo o direcionamento entre dispositivos e personalizado. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Público → User Explorer

Identificadores de mensagens

Código da mensagem

Um identificador exclusivo atribuído a cada mensagem no momento da criação. Ele segue um formato específico: XXXX-XXXXXXXX-XXXXXXXX.

Este código é essencial para:

Rastrear o status e a entrega de uma mensagem específica
Cancelar (ou excluir) uma mensagem enviada anteriormente
Obter estatísticas da mensagem

Onde encontrar

Painel de Controle da Pushwoosh: Navegue até o Histórico de mensagens, depois abra as propriedades da mensagem desejada. O Código da Mensagem será exibido lá.
Resposta da API /createMessage: Ao criar uma nova mensagem via API, o Código da Mensagem é incluído na resposta.

Identificadores de conteúdo

Código da predefinição

Um identificador para uma predefinição de mensagem salva (por exemplo, push ou SMS). Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Conteúdo → Predefinições.

Você pode encontrar o código da predefinição em dois lugares:

Na visualização de lista, exibido abaixo do nome da predefinição.
Na URL ao editar ou criar uma predefinição (é a última parte da URL).

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

Código da predefinição: AAAAA-BBBBB

Código de rich media

Identificador para um modelo de mensagem in-app. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Conteúdo → Rich media.

Exemplo: URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics Código de rich media: AAAAA-BBBBB

Código de conteúdo de e-mail

O código de conteúdo de e-mail é um identificador exclusivo para o conteúdo de e-mail salvo. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Conteúdo → Conteúdo de e-mail.

O código é a última parte da URL.

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB Código de conteúdo de e-mail: AAAAA-BBBBB

Identificadores de campanha

Código da campanha

Um identificador exclusivo usado para referenciar uma campanha específica para rastreamento e análise.

Onde encontrar

O código da campanha aparece na URL ao visualizar estatísticas relacionadas à campanha no Painel de Controle da Pushwoosh. Para localizá-lo, vá para Estatísticas → Estatísticas agregadas, clique na campanha desejada e copie o código encontrado no final da URL.

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

Código da campanha: YYYYY-YYYYY

ID da Journey

Um identificador exclusivo usado para associar mensagens a campanhas de marketing específicas para rastreamento e análise de desempenho.

Onde encontrar

O ID da Journey aparece na URL da tela da campanha no Painel de Controle da Pushwoosh.

Exemplo: URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

ID da Journey: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Identificadores de segmentação e direcionamento

Nome do Segmento / Filtro

O nome de um segmento de usuário predefinido criado na Pushwoosh para direcionamento de público. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Segmentos.

Código do Segmento / Filtro

Um código exclusivo no formato XXXXX-XXXXX que identifica um segmento (também chamado de filtro) na Pushwoosh. Este código é usado em chamadas de API, lógica de automação e regras de segmentação dinâmica.

Onde encontrar

Através do método da API /listFilters.
Na barra de endereço ao visualizar um segmento no Painel de Controle da Pushwoosh:

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail Código do segmento: XXXE9-XXX49

Tag

Um atributo personalizado atribuído a usuários ou dispositivos. Usado para segmentação dinâmica e personalização. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Tags ou via API /getTags.

Identificadores de evento

Nome do evento

O nome de um evento rastreado (por exemplo, purchase, login, subscription). Usado para acionar fluxos de trabalho automatizados ou para análise. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Público → Eventos.

Identificadores de geolocalização

ID da Geozone

Identifica uma área de geofence usada para acionar notificações baseadas em localização. Saiba mais

Onde encontrar

Painel de Controle da Pushwoosh → Geozones.