API Access token

El API Access Token es un identificador único asignado a un proyecto particular o a varios proyectos en su cuenta. Autentica su cuenta para gestionar sus proyectos a través de la API, incluyendo modificaciones de cuenta, envío de mensajes, edición de proyectos, etc.

Tipos de API Access token

Pushwoosh proporciona dos tipos diferentes de API Access Token: Server y Device.

Cada tipo de token solo es válido para su ámbito de API específico. Ocurrirá un error de autenticación si se utiliza el token incorrecto.

Server API token

El Server API token se utiliza con todos los métodos de la API, excepto aquellos bajo la Device API. Debe incluirse en el cuerpo de la solicitud en el campo auth.

Device API token

El Device API token se utiliza exclusivamente con los métodos de la Device API. Debe incluirse en los encabezados de la solicitud HTTP utilizando el encabezado Authorization. A continuación se muestra un ejemplo del formato de encabezado correcto:

Authorization: Token <device_api_token>

Reemplace <device_api_token> con el valor real de su Device API Token.

Crear y gestionar tokens de acceso a la API

Puede ver, crear y gestionar sus API Access tokens en la sección API Access del Panel de Control de Pushwoosh. Para acceder, vaya a Settings → API Access. Pushwoosh Demo App token

Por defecto, cada cuenta incluye un token llamado Pushwoosh Demo App, que está configurado como un token de servidor.

Crear un nuevo API Access token

Para crear un nuevo API Access token:

Vaya a la sección API Access en el Panel de Control.
Haga clic en Generate New Token.
En la ventana que aparece, elija el tipo de token:
- Server utilizado para la mayoría de los métodos de la API (excluyendo los métodos de Device API).
- Device utilizado solo para métodos de Device API.
Introduzca un nombre para el token.
Haga clic en Generate para crear el token.

Generate a New Token

Importante: Asegúrese de dar al token acceso a la aplicación correcta en su Panel de Control de Pushwoosh. Más información

El nuevo token aparecerá en la lista de API Access. Desde allí, puede copiar su valor para usarlo en solicitudes de API o gestionar sus permisos de acceso según sea necesario.

Gestionar un token

Para gestionar un token de API existente, haga clic en el menú de tres puntos (⋮) junto a la entrada del token en la sección API Access.

Manage a token

Las siguientes opciones están disponibles:

Grant access to all projects (Conceder acceso a todos los proyectos)

Da al token acceso a todos los proyectos en su cuenta. Esto le permite utilizar completamente la API en todos los proyectos.

Revoke access from all projects (Revocar acceso de todos los proyectos)

Elimina el acceso del token a todos los proyectos en su cuenta. El token ya no podrá utilizar la API hasta que se le conceda acceso de nuevo.

Edit token (Editar token)

Abre la pantalla Edit API Token Permissions, donde puede:

Cambiar el nombre del token
Copiar el valor del token
Elegir a qué proyectos puede acceder el token seleccionándolos o deseleccionándolos en la lista

Manage a token

Después de terminar de hacer cambios, haga clic en Save para aplicarlos.

Delete token (Eliminar token)

Elimina permanentemente el token de su cuenta.

Autorizar solicitudes de API

Para autorizar solicitudes de API, utilice el tipo correcto de API Access token basado en el tipo de método de API que esté llamando:

Para métodos de Server API

Incluya el token en el campo “auth” del cuerpo de la solicitud:

Ejemplo:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // pegue su token de servidor aquí
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

Para métodos de Device API

Utilice el Device token. Inclúyalo en el encabezado de la solicitud HTTP utilizando el siguiente formato:

Authorization: Token <device_api_token>

Reemplace <device_api_token> con el valor real de su token.