Visão geral da API Pushwoosh

A API Pushwoosh permite que os desenvolvedores interajam com a plataforma Pushwoosh.

O que você pode fazer com a API Pushwoosh?

Com a API Pushwoosh, você obtém acesso a uma extensa biblioteca de mais de 100 métodos que permitem:

• Enviar notificações push personalizadas
• Criar, importar, exportar e gerenciar segmentos de usuários para um direcionamento preciso
• Utilizar APIs em massa para gerenciar usuários/dispositivos em lotes
• Configurar aplicativos
• Rastrear eventos de usuários e adicionar tags aos usuários para aprimorar o direcionamento e a personalização
• Criar e gerenciar Entidades Pushwoosh, como predefinições, tags, eventos, aplicativos, etc.
• Iniciar Customer Journeys da Pushwoosh via API
• Recuperar estatísticas abrangentes sobre Customer Journeys e Campanhas de Push/E-mail/SMS.
• Implementar geofencing para enviar notificações baseadas em localização quando os usuários entram ou saem de áreas geográficas específicas
• Integrar perfeitamente serviços de terceiros com a Pushwoosh

Para explorar a gama completa de métodos disponíveis e descobrir as extensas capacidades da API Pushwoosh, consulte o índice de referência de métodos da API.

Autenticação

A API Pushwoosh usa tokens de API para autenticar solicitações. Existem dois tipos de tokens: Servidor e Dispositivo, cada um usado para escopos de API específicos.

Cada conta Pushwoosh vem com um Token de Acesso à API padrão criado para o Aplicativo de Demonstração Pushwoosh. Você pode visualizar, criar e gerenciar seus tokens de API no Painel de Controle da Pushwoosh.

Saiba mais

Limites de taxa

Um limite de taxa é o número de solicitações que a API pode receber em um determinado período. Embora a maioria das solicitações de API na Pushwoosh não seja limitada, as solicitações da API /createMessage são limitadas a 600 por minuto para garantir a qualidade do serviço para todos os usuários.

Solicitações

O HTTPS é obrigatório para todas as solicitações de API, garantindo a transferência segura de dados.

Respostas

A API Pushwoosh normalmente retorna respostas em JSON.

Códigos de sucesso e erro

Códigos de sucesso

Quando sua solicitação de API for processada com sucesso, você receberá um código de sucesso como parte da resposta.

Código de status HTTP	Mensagem de status	Descrição
200	OK	A Pushwoosh processou a solicitação com sucesso

Observe que, quando você recebe uma resposta HTTP 200, isso significa que sua solicitação foi entendida e processada com sucesso, mas não garante o sucesso da ação. Portanto, certifique-se de verificar mensagens de erro ou aviso (acesso negado, aplicativo não encontrado, chave de API inválida, etc.) para determinar o sucesso da ação.

Código de status	Mensagem de status
200	Avisos: Você atingiu o limite de assinantes. A Mensagem Push será enviada para apenas 1 dispositivo aleatório
200	Avisos: Você excedeu o número de dispositivos ativos permitidos em seu plano de assinatura atual.
210	Acesso negado ou aplicativo não encontrado
210	Aplicativo não encontrado
210	Aplicativo suspenso
210	Conta não encontrada
210	A conta foi suspensa
210	Conta suspensa não pode usar filtragem de dispositivos
210	Token de API ou aplicativo não está definido
210	Por favor, selecione pelo menos uma plataforma
210	Token de API inválido: Conta não encontrada
210	Nenhum código de aplicativo ou grupo fornecido
210	Token de API, aplicativo ou conta não está definido

Códigos de erro

Caso sua solicitação não esteja formatada corretamente, encontre problemas de processamento ou experimente quaisquer outros erros, a Pushwoosh enviará um código de erro indicando a natureza do problema, ajudando você a solucionar e resolver o problema de forma eficaz.

Código de status HTTP	Mensagem de status	Descrição
400	Solicitação inválida	A solicitação não pode ser atendida devido à sintaxe incorreta
401	Não autorizado	A autenticação falhou ou não foi fornecida
403	As restrições do token proíbem esta operação.	Seu token de acesso não possui as permissões necessárias para executar a ação solicitada. Para corrigir isso, revise as permissões do seu token de acesso no painel de controle da Pushwoosh e ajuste-as conforme necessário para corresponder aos requisitos da operação específica que você deseja realizar.
404	Recurso não encontrado	Indica que o recurso solicitado, como um aplicativo, não pôde ser localizado ou não existe no servidor.
500	Erro interno	Houve um problema ou erro inesperado no servidor ao processar a solicitação da API.