Resumen de la API de Pushwoosh

La API de Pushwoosh permite a los desarrolladores interactuar con la plataforma Pushwoosh.

¿Qué puede hacer con la API de Pushwoosh?

Con la API de Pushwoosh, obtiene acceso a una extensa biblioteca de más de 100 métodos que le permiten:

• Enviar notificaciones push personalizadas
• Crear, importar, exportar y gestionar segmentos de usuarios para una segmentación precisa
• Utilizar APIs masivas para gestionar usuarios/dispositivos en lotes
• Configurar aplicaciones
• Rastrear eventos de usuario y añadir etiquetas a los usuarios para mejorar la segmentación y la personalización
• Crear y gestionar Entidades de Pushwoosh como presets, etiquetas, eventos, aplicaciones, etc.
• Iniciar Customer Journeys de Pushwoosh a través de la API
• Recuperar estadísticas completas sobre Customer Journeys y Campañas de Push/Email/SMS.
• Implementar geofencing para enviar notificaciones basadas en la ubicación cuando los usuarios entran o salen de áreas geográficas específicas
• Integrar sin problemas servicios de terceros con Pushwoosh

Para explorar la gama completa de métodos disponibles y descubrir las amplias capacidades de la API de Pushwoosh, consulte el índice de referencia de métodos de la API.

Autenticación

La API de Pushwoosh utiliza tokens de API para autenticar las peticiones. Hay dos tipos de tokens: Servidor y Dispositivo, cada uno utilizado para ámbitos específicos de la API.

Cada cuenta de Pushwoosh viene con un Token de Acceso a la API predeterminado creado para la Aplicación de Demostración de Pushwoosh. Puede ver, crear y gestionar sus tokens de API en el Panel de Control de Pushwoosh.

Más información

Límites de velocidad

Un límite de velocidad es el número de peticiones que la API puede recibir en un período determinado. Aunque la mayoría de las peticiones de la API en Pushwoosh no están limitadas, las peticiones de la API /createMessage están limitadas a 600 por minuto para garantizar la calidad del servicio para todos los usuarios.

Peticiones

HTTPS es obligatorio para todas las peticiones de la API, garantizando una transferencia de datos segura.

Respuestas

La API de Pushwoosh normalmente devuelve respuestas en formato JSON.

Códigos de éxito y de error

Códigos de éxito

Cuando su petición a la API se procesa con éxito, recibirá un código de éxito como parte de la respuesta.

Código de estado HTTP	Mensaje de estado	Descripción
200	OK	Pushwoosh procesó la petición con éxito

Tenga en cuenta que cuando obtiene una respuesta HTTP 200, significa que su petición fue entendida y procesada con éxito, pero no garantiza el éxito de la acción. Así que asegúrese de comprobar si hay mensajes de error o advertencia (acceso denegado, aplicación no encontrada, clave de API no válida, etc.) para determinar el éxito de la acción.

Código de estado	Mensaje de estado
200	Advertencias: Ha alcanzado el límite de suscriptores. El mensaje push se enviará solo a 1 dispositivo aleatorio
200	Advertencias: Ha excedido el número de dispositivos activos permitidos en su plan de suscripción actual.
210	Acceso denegado o aplicación no encontrada
210	Aplicación no encontrada
210	Aplicación suspendida
210	Cuenta no encontrada
210	La cuenta ha sido suspendida
210	La cuenta suspendida no puede usar el filtrado de dispositivos
210	El token de API o la aplicación no están configurados
210	Por favor, seleccione al menos una plataforma
210	Token de API no válido: Cuenta no encontrada
210	No se ha proporcionado ningún código de aplicación o grupo
210	El token de API, la aplicación o la cuenta no están configurados

Códigos de error

En caso de que su petición no esté correctamente formateada, encuentre problemas de procesamiento o experimente cualquier otro error, Pushwoosh le enviará un código de error que indica la naturaleza del problema, ayudándole a solucionar y abordar el problema de manera efectiva.

Código de estado HTTP	Mensaje de estado	Descripción
400	Bad request	La petición no se puede completar debido a una sintaxis incorrecta
401	Unauthorized	La autenticación ha fallado o no se ha proporcionado
403	Token restrictions forbid this operation.	Su token de acceso carece de los permisos necesarios para realizar la acción solicitada. Para solucionarlo, revise los permisos de su token de acceso en el panel de control de Pushwoosh y ajústelos según sea necesario para que coincidan con los requisitos de la operación específica que desea llevar a cabo.
404	Resource not found	Indica que el recurso solicitado, como una aplicación, no se pudo localizar o no existe en el servidor.
500	Internal error	Hubo un problema o error inesperado en el servidor al procesar la petición de la API.