API to ESP Overview
API to ESP is our new easy way to automate sending only valid leads directly over to the email platform of your choice. We have many ESPs that we are currently integrated with, but we are constantly adding more. So, if you don’t see your ESP on our list at the moment check back frequently, or feel free to send a request to email@example.com
Here is a basic overview to help you get the setup started. In most cases, you will need to be able to supply an API key of your email platform to be able to connect. We will have the details on how to locate this information when you click on the ESP you want to integrate with from the left navigation menu.
- Enabling Data Sending via XVerifyThe first thing you will need to do is go into your XVerify account and enable sending of data to your ESP. You can do by logging into your XVerify account, clicking on “Settings” and clicking on “Email” and then scrolling to the bottom until you see an area called SEND TO ESP. You need to turn this on, and then save your changes.
- Connect to Your ESP In this next step you will connect to your desired ESP by going into your XVerify dashboard, clicking on “Batch Upload” and then click on the option that says “Connect to ESP”
- Creating a Connection On the next screen, you will see a list of the current integrations we have available. If the ESP you would like to connect with appears on this list then click the “Connect” button.
***NOTE – once you press connect you will be required to enter in details such as an API key associated with your ESP. Click on the name of your ESP on the left to learn more about integrating for that specific email platform.
- The API Call Once you have successfully setup your ESP it’s time for you to make the API call. You would locate your standard email verification API and add on a few extra pieces of information depending upon what is required for the ESP you are choosing to integrate with. You can find out which fields are required by seeing the documentation for the ESP you selected.Examples of the code you would need to add on to your standard API call:&esps[espname]=mailgun ( Required )
&esps[listid]=firstname.lastname@example.org ( Required in some esps)
&esps[userdata][name]=Asim%20Arif ( optional )
&esps[userdata][age]=20 ( optional )
&esps[userdata][gender]=m ( optional )
&esps[userdata][first_name]=Arif ( optional )
&esps[userdata][last_name]=Arif ( optional )
- Successful API call after you have properly formatted the API call and submitted your request, if everything was done properly then you should get a success message. For example in this XML response you should see an error that looks like such:
IF you do not see the tag for ESP_OUTPUT in your file then most likely you did not enable the send to ESP option. Which you must do during step 1 of the setup process.
- Unsuccessful API calls can occur when you do not have the required information in the API call, or you do not have the ESP properly connected. To identify the details your ESP requires to be passed please see the documentation for the ESP you are trying to integrate with. You may also see an output error when you attempt to insert duplicate records.