Skip to content

Latest commit

 

History

History
303 lines (270 loc) · 11.9 KB

documentation_es.md

File metadata and controls

303 lines (270 loc) · 11.9 KB
Raw
Instalación (CocoaPods)

Agrega el pod a tu Podfile

pod 'ZeroBounceSDK'

y ejecuta

pod install

USO

Importa el SDK en tu archivo:

import ZeroBounceSDK

Inicializa el SDK con tu clave de API:

ZeroBounceSDK.shared.initialize(apiKey: "<TU_CLAVE_DE_API>")

Ejemplos

Luego puedes utilizar cualquiera de los métodos del SDK, por ejemplo:

  • ####### Validar una dirección de correo electrónico
let email = "<DIRECCIÓN_DE_CORREO>"   // La dirección de correo electrónico que deseas validar
let ipAddress = "127.0.0.1"     // La dirección IP desde la cual se registró el correo electrónico (opcional)

ZeroBounceSDK.shared.validate(email: email, ipAddress: ipAddress) { result in
    switch result {
    case .success(let response):
        NSLog("validate success response=\(response)")
    case .failure(let error):
        NSLog("validate failure error=\(String(describing: error))")
        switch error as? ZBError {
        case .notInitialized:
            break
        case .decodeError(let messages):
            /// decodeError se utiliza para extraer y decodificar errores y mensajes
            /// cuando no forman parte del objeto de respuesta
            break
        default:
            break
        }
    }
}
  • ####### Validar hasta 100 direcciones de correo electrónico utilizando Batch Email Validator
// Las direcciones de correo electrónico que deseas validar
let emails = [
    ["email_address": "<DIRECCIÓN_DE_CORREO_1>"],
    ["email_address": "<DIRECCIÓN_DE_CORREO_2>", "ip_address": "127.0.0.1"]
]

ZeroBounceSDK.shared.validateBatch(emails: emails) { result in
    switch result {
    case .success(let response):
        NSLog("validate success response=\(response)")
    case .failure(let error):
        NSLog("validate failure error=\(String(describing: error))")
    }
}
  • ####### Encuentre el correo electrónico y otros formatos de dominio según un nombre de dominio específico
let domain = "<DOMAIN_NAME>"   // El nombre de dominio para el que quiere encontrar el formato de correo electrónico.
let firstName = "<FIRST_NAME>" // El primer nombre de la persona para la que se busca el formato de correo electrónico. [Opcional]
let middleName = "<MIDDLE_NAME>" // El segundo nombre de la persona para la que se busca el formato de correo electrónico. [Opcional]
let lastName = "<LAST_NAME>" // El apellido de la persona para la que se busca el formato de correo electrónico. [Opcional]

ZeroBounceSDK.shared.guessFormat(
    domain: domain,
    firstName: firstName,
    middleName: middleName,
    lastName: lastName
) { result in
    switch result {
    case .Success(let response):
        NSLog("guessFormat success response=\(response)")
    case .Failure(let error):
        NSLog("guessFormat failure error=\(String(describing: error))")
    }
}
  • ####### Verificar cuántos créditos te quedan en tu cuenta
ZeroBounceSDK.shared.getCredits() { result in
    switch result {
    case .success(let response):
        NSLog("getCredits success response=\(response)")
        let credits = response.credits
    case .failure(let error):
        NSLog("getCredits failure error=\(String(describing: error))")
    }
}
  • ####### Verificar si tu bandeja de entrada de correo electrónico ha estado activa en los últimos 30, 60, 90, 180, 365, 730 o 1095 días
let email = "<DIRECCIÓN_DE_CORREO>"   // La dirección de correo electrónico que deseas validar

ZeroBounceSDK.shared.getActivityData(email: email) { result in
    switch result {
    case .success(let response):
        NSLog("getActivityData success response=\(response)")
    case .failure(let error):
        NSLog("getActivityData failure error=\(String(describing: error))")
    }
}
  • ####### Verificar el uso de tu API durante un período de tiempo determinado
let startDate = Date();    // La fecha de inicio desde la cual deseas ver el uso de la API
let endDate = Date();      // La

 fecha de finalización hasta la cual deseas ver el uso de la API

ZeroBounceSDK.shared.getApiUsage(startDate: startDate, endDate: endDate) { result in
    switch result {
    case .success(let response):
        NSLog("getApiUsage success response=\(response)")
    case .failure(let error):
        NSLog("getApiUsage failure error=\(String(describing: error))")
    }
}
  • ####### La API sendfile permite enviar un archivo para la validación masiva de correos electrónicos
let filePath = File("<RUTA_DEL_ARCHIVO>") // El archivo csv o txt
let emailAddressColumn = 3;         // El índice de la columna "email" en el archivo. El índice comienza en 1
let firstNameColumn = 3;            // El índice de la columna "nombre" en el archivo
let lastNameColumn = 3;             // El índice de la columna "apellido" en el archivo
let genderColumn = 3;               // El índice de la columna "género" en el archivo
let ipAddressColumn = 3;            // El índice de la columna "dirección IP" en el archivo
let hasHeaderRow = true;            // Si es `true`, se considera que la primera fila contiene los encabezados de la tabla
let returnUrl = "https://dominio.com/llamada/despues/de/procesar/solicitud";

ZeroBounceSDK.shared.sendFile(
    filePath: filePath,
    emailAddressColumn: emailAddressColumn,
    returnUrl: returnUrl,
    firstNameColumn: firstNameColumn,
    lastNameColumn: lastNameColumn,
    genderColumn: genderColumn,
    ipAddressColumn: ipAddressColumn,
    hasHeaderRow: hasHeaderRow
) { result in
    switch result {
    case .Success(let response):
        NSLog("sendFile success response=\(response)")
    case .Failure(let error):
        NSLog("sendFile failure error=\(String(describing: error))")
    }
}
  • ####### La API getfile permite a los usuarios obtener el archivo de resultados de validación del archivo enviado mediante la API sendfile
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API sendfile

ZeroBounceSDK.shared.getfile(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("getfile success response=\(response)")
    case .failure(let error):
        NSLog("getfile failure error=\(String(describing: error))")
    }
}
  • ####### Verificar el estado de un archivo cargado mediante el método "sendFile"
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API sendfile

ZeroBounceSDK.shared.fileStatus(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("fileStatus success response=\(response)")
    case .failure(let error):
        NSLog("fileStatus failure error=\(String(describing: error))")
    }
}
  • ####### Elimina el archivo que se envió mediante la API "sendFile". El archivo solo se puede eliminar cuando su estado es Complete
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API sendfile

ZeroBounceSDK.shared.deleteFile(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("deleteFile success response=\(response)")
    case .failure(let error):
        NSLog("deleteFile failure error=\(String(describing: error))")
    }
}
API de puntuación de AI
  • ####### La API scoringSendFile permite enviar un archivo para la validación masiva de correos electrónicos
let filePath = File("<RUTA_DEL_ARCHIVO>") // El archivo csv o txt
let emailAddressColumn = 3;         // El índice de la columna "email" en el archivo. El índice comienza en 1
let hasHeaderRow = true;            // Si es `true`, se considera que la primera fila contiene los encabezados de la tabla
let returnUrl = "https://dominio.com/llamada/despues/de/procesar/solicitud";

ZeroBounceSDK.shared.scoringSendFile(
    filePath: filePath,
    emailAddressColumn: emailAddressColumn,
    returnUrl: returnUrl,
    hasHeaderRow: hasHeaderRow
) { result in
    switch result {
    case .Success(let response):
        NSLog("sendFile success response=\(response)")
    case .Failure(let error):
        NSLog("sendFile failure error=\(String(describing: error))")
    }
}
  • ####### La API scoringGetFile permite a los usuarios obtener el archivo de resultados de validación para el archivo enviado mediante la API scoringSendFile
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API scoringSendFile

ZeroBounceSDK.shared.scoringGetfile(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("getfile success response=\(response)")
    case .failure(let error):
        NSLog("getfile failure error=\(String(describing: error))")
    }
}
  • ####### Verificar el estado de un archivo cargado mediante el método "scoringSendFile"
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API scoringSendFile

ZeroBounceSDK.shared.scoringFileStatus(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("fileStatus success response=\(response)")
    case .failure(let error):
        NSLog("fileStatus failure error=\(String(describing: error))")
    }
}
  • ####### Elimina el archivo que se envió mediante la API scoring scoringSendFile. El archivo solo se puede eliminar cuando su estado es Complete
let fileId = "<ID_DEL_ARCHIVO>";    // El ID de archivo devuelto al llamar a la API scoringSendFile

ZeroBounceSDK.shared.scoringDeleteFile(fileId: fileId) { result in
    switch result {
    case .success(let response):
        NSLog("deleteFile success response=\(response)")
    case .failure(let error):
        NSLog("deleteFile failure error=\(String(describing: error))")
    }
}

Aplicación de ejemplo

  • También puedes clonar el repositorio y acceder a la aplicación de ejemplo dentro del proyecto para ver algunos ejemplos. Simplemente inicializa el SDK con tu propia clave de API y descomenta el punto final que deseas probar.

Puedes utilizar cualquiera de las siguientes direcciones de correo electrónico para probar la API, no se cobran créditos por estas direcciones de correo electrónico de prueba: