Docs
Docs
La API de Inbox Placement Tester te permite crear, supervisar y gestionar pruebas de ubicación en la bandeja de entrada desde tu aplicación. Una prueba proporciona direcciones de correo semilla en distintos proveedores para que puedas enviar una campaña y ver si llega a la bandeja de entrada o a la carpeta de spam.
Usa la API para automatizar la creación de pruebas, obtener los resultados de ubicación y recibir un webhook cuando una prueba haya finalizado.
Todos los endpoints siguientes usan esta ruta base:
Autentica cada solicitud con tu clave de API de ZeroBounce:
También puedes enviar la clave como api_key o apiKey en la cadena de consulta.
GET /api/ipt/providers.POST /api/ipt/test.GET /api/ipt/test/{id} o configura un webhook y espera el resultado final.Las llamadas a la API de Inbox Placement Tester usan los mismos créditos de pruebas de bandeja de entrada que el panel de ZeroBounce. La creación de una prueba falla cuando la cuenta no tiene pruebas disponibles.
emailAddressList devuelta. La lista incluye testid+{identifier}@zbtest.org.senderEmail obligatorioFrom.3 (Auto Alias) es el tipo de prueba predeterminado.
POST /api/ipt/test
Crea una prueba de ubicación en la bandeja de entrada y recibe las direcciones semilla que debes usar en la campaña.
name- / \\ , . & ' ( ). El nombre debe ser único entre las pruebas en curso y finalizadas.testType3 (Auto Alias).senderEmailtestType es 1.providerIdsseedIdsprovidersid y maxSeeds; maxSeeds debe ser al menos 1.webhookUrlSi no indicas providerIds, seedIds ni providers, la prueba usa todas las semillas activas. Cada prueba debe incluir al menos una semilla que no sea de gateway; las semillas de gateway de Mimecast y Proofpoint por sí solas no son suficientes.
Crea una prueba Auto Alias predeterminada:
Crea una prueba que use solo semillas de Gmail:
Crea una prueba Email coincidente por la dirección From:
La API devuelve 201 Created.
Envía la campaña con el método del tipo de prueba devuelto. En las pruebas Auto Alias, envía a todas las direcciones de emailAddressList.
GET /api/ipt/providers
Obtén los proveedores de semillas disponibles para pruebas nuevas. Usa los IDs de emailProviders.items y gatewayProviders.items en providerIds o providers al crear una prueba.
Cada elemento de proveedor incluye:
idnamelocationseedCountseedIdsGET /api/ipt/test-types
Obtén los tipos de prueba admitidos y el tipo predeterminado. El predeterminado es 3 (Auto Alias).
GET /api/ipt/test/{id}
Obtén el estado actual y los resultados de ubicación de una prueba. Este endpoint no acepta cuerpo de solicitud.
La respuesta incluye el estado de la prueba, los recuentos, los porcentajes, los resultados y el detalle por semilla en seeds.
statusrunning o finishedinboxCountspamCountpendingCountpercentagesresultsseedsUsa este endpoint para consultar una prueba en curso hasta que el estado sea finished.
GET /api/ipt/tests
Lista las pruebas de Inbox Placement Tester de la clave de API autenticada.
statusrunning o finished.createdAftercreatedBeforepage1.page_size25; el máximo es 100.DELETE /api/ipt/test/{id}
Elimina una prueba finalizada. Solo se pueden eliminar las pruebas finalizadas; intentar eliminar una prueba en curso devuelve 400 Bad Request.
Cuando finaliza una prueba creada mediante la API pública de IPT, enviamos los resultados por POST a una URL que tú defines. Una URL por clave de API. Se envía una vez (con reintentos ante errores de red o HTTP).
Valor predeterminado de la clave:
PUT /api/ipt/webhook
GET /api/ipt/webhook devuelve la URL actual (o "").
Al crear:
webhookUrl opcional en POST /api/ipt/test. Se usa para esa prueba y se guarda como valor predeterminado de la clave.POST JSON, el mismo cuerpo que GET /api/ipt/test/{id}:
id, testName, testType, identifier, status (finished)counts: inboxCount, spamCount, otherCount, notDeliveredCount, pendingCount, percentagesresults y seeds por cada semillaTu endpoint debe aceptar application/json y devolver 2xx.
Sustituye YOUR_API_HOST por el host de API de ZeroBounce correspondiente y YOUR_API_KEY por una clave de API de tu cuenta de ZeroBounce.