Acesso e Permissões à API

Prev Next

Adicionar ID de Cliente

Para criar um ID de cliente, faça o seguinte:

  1. Vá em Configurações > Integrações > Integrações de API.

  2. Clique em Criar ID de Cliente e insira um nome para a integração.

  3. Clique em salvar. Um ID de Cliente é gerado automaticamente para você.

Escopos de Cenários

Selecione Escopos Definidos para o ID do Cliente correspondente para gerenciar suas permissões. As tabelas descrevem a funcionalidade disponível para cada escopo. Cada operação inclui uma caixa de seleção que permite habilitar ou desativar acessos específicos.

Todas as alterações no escopo são registradas nas colunas Atualizado Até e Tempo Atualizado .

Operações Comuns

Escopo

Permissões

Referência API

Criar

  • Crie uma campanha automatizada ou crie uma campanha a ser enviada imediatamente

  • Crie um segmento que será associado ao seu projeto

  • Crie uma lista de usuários que estarão associados ao seu projeto

  • Crie uma nova tag ou um atributo.

Criação em lote

Crie um lote de novas tags ou atributos

Tags de criação em lote

Atualização

  • Atualize uma campanha que já foi criada

  • Atualize um segmento existente

  • Atualize uma lista de usuários existente

Excluir

  • Exclua um segmento

  • Exclua uma lista de usuários

Lista

  • Campanhas criadas por lista

  • Liste os dispositivos que usam sua aplicação

  • Perfis de usuário criados por lista

  • Liste os segmentos associados ao seu projeto

  • Liste todas as listas associadas ao seu projeto

  • Liste todos os itens da lista

  • Lista de informações sobre ações push relacionadas a campanhas

  • Liste informações das ações push enviadas para dispositivos ou perfis individuais

  • Liste status de assinatura a partir dos perfis de usuário

  • Listar valores de atributos de perfil a partir de perfis de usuário

  • Liste informações sobre preferências de consentimento para um perfil de usuário

  • Liste as tags que foram reportadas no seu projeto

  • Informações da lista sobre dispositivos que atingem tags

  • Liste informações sobre atributos associados a usuários ou dispositivos

  • Lista as tarefas associadas ao seu projeto

  • Listas de promoções sincronizadas por motores de bônus conectados

  • Liste registros de histórico OTP com base em parâmetros de entrada específicos

Informações

  • Obtenha informações sobre uma única campanha

  • Obtenha detalhes sobre um único dispositivo usando seu aplicativo

  • Obtenha informações em um perfil de usuário

  • Obtenha informações sobre um único segmento

  • Obtenha informações sobre uma lista de usuários únicos

  • Obtenha informações sobre tarefas de dados assíncronas, como importações ou exclusãos

  • Obtenha informações sobre uma única ação de notificação push

  • Obtenha informações sobre os registros OTP.

Operações de Campanha

Escopo

Permissões

Referência API

Enviar

Envie uma única campanha

Enviar

Executar

Executar uma campanha

Executar

Comece

Comece uma campanha pausada/parada

Comece

Pare

Campanha de parada e ativa

Pare

Cronograma

Agende uma campanha

Expirar a Caixa de Entrada

Expirar uma campanha inteira na caixa de entrada que está no andamento

Expirar a Caixa de Entrada

Remover Caixa de Entrada

Remover uma mensagem da caixa de entrada que já foi enviada

Remover Caixa de Entrada

Cancelar Jornada

Fazer com que um usuário ou uma lista de usuários conclua uma jornada em múltiplas etapas, impedindo que recebam mais mensagens

Cancelar Jornada

Operações de Ataque

Escopo

Permissões

Referência API

Tag

  • Adicione uma tag ou atualize um atributo quando um evento ocorrer ou um atributo mudar fora do seu app

  • Adicione tags ou atualize atributos quando um evento ocorre ou um atributo muda fora do seu app

Evento

  • Envie um evento em tempo real para o Xtremepush quando um evento ocorre em um sistema backend

  • Envie eventos em tempo real para o Xtremepush em lote quando eventos ocorrem em um sistema backend

Outras Operações

Escopo

Permissões

Referência API

Importação

  • Criar novos perfis de usuário e/ou definir atributos para esses perfis

  • Importe/atualize os valores da lista de usuários que serão associados ao seu projeto.

  • Adicione/remova destinatários para/de uma lista de supressão.

Exportação

Acione uma tarefa em segundo plano para exportar dados de dispositivo ou perfil para um segmento específico

Extensão do Segmento de Gatilhot

Análise

  • Informações de retorno sobre novos usuários ao longo de um determinado período de tempo

  • Informações de retorno sobre o total de sessões em um determinado período de tempo

  • Informações de retorno sobre sessões únicas em um determinado período de tempo

  • Retorne informações sobre o tempo total da sessão em um determinado período, a unidade é em segundos

  • Retorne informações sobre o tempo médio de sessão em um determinado período, a unidade é em segundos

  • Retorna novos usuários, total de sessões, sessões únicas, tempo total de sessões e tempo médio de sessão em uma única solicitação

  • Estatísticas de retorno de todas as campanhas ou de campanhas específicas

  • Informações de retorno em entradas de localização em um determinado período de tempo

Baixar o Arquivo

Recupere um arquivo específico usando seu identificador único de arquivo.

Baixar o arquivo por ID

Ações de Integração

  • Crie e envie senhas de uso único (OTPs) para os usuários para autenticação segura.

  • Envie seu próprio OTP para seus usuários

  • Valide senhas de uso único (OTPs) inseridas pelos usuários contra OTPs previamente gerados e armazenados.

  • Assine um cliente para atualizações esportivas em tempo real

  • Desassine um cliente das atualizações esportivas em tempo real

Ações de Dados

  • Exclua todos os dados pessoais de um perfil de usuário e de dispositivos associados ao perfil do usuário.

  • Excluir dados pessoais do dispositivo