Follow

Accessing the API

The XML FTP API allows you to control data and deployment using files sent to the server via FTP or SFTP. 

Some of the features available through the XML FTP API include:

  • One-off message deployment
  • Customizable one-off message deployment
  • Campaign deployment

Accessing the API

The XML FTP API interface is designed to be transacted entirely through flat files transferred to the platform in a passive, asynchronous manner using the industry standard protocol FTP.  These files contain batches of commands to perform data manipulation.  Although you may create software to generate and upload these files, you may also use a simple text editor to prepare command files and an FTP program.

The XML FTP API’s disconnected interface is what differentiates it from the HTTP or WebServices APIs.  This mechanism relies upon externally created XML formatted command files deposited into a directory maintained on a server.  A special daemon process sweeps through the directory at a regular interval scanning for files.  When it encounters new files, it processes them by reading and interpreting the commands.

Credentials

Before you can use the API, you must first request access credentials from the support team.  In your request, include the following:

  • Email Address
  • Name
  • Broadcaster/System Name
  • Realm Name
  • Static IP or IP Range

You will receive an email response with the URL for server and directory access and your password.  The login password to access the XML FTP API server is case sensitive.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk