4th edition of the API Newsletter
We're excited to bring you the 4th edition of our API newsletter.
Please contact us with any suggestions or feedback about how we can make this more useful for you!
Methods
The media library is now accessible using the API! Now you can manage your images using any of the methods below:
FileSpec
A FileSpec object represents a file that is to be transferred into or out of VerticalResponse or a file that exists inside the Media Library. The various fields of a FileSpec object are used or not used depending on the context.When transferring files into out of VerticalResponse, the filename and delimiter fields are used as well as either the location or contents field. The delimiter field is used when uploading files for operations such as appendFileToList() where the system needs to know the tabular format of the data. The contents can be set to the base64-encoded contents of the file being uploaded, or a URL can be placed in the location field indicating that that system should retrieve the file there. Note that some SOAP toolkits automatically base64-encode the contents field since it's declared as a soapenc:base64-type field in the WSDL.
The media_library_directory, is_directory, size and last_modified fields correspond to properties of Media Library files. Such files include directories and regular files. The media_library_directory field indicates the file's location in the Media Library. The root Media Library directory is referenced as "/". The is_directory field indicates whether the file is a directory or a regular file. The size is reported as a byte count, and the last_modified field is reported in UTC time.
For example, a file called "unicorn.jpg" living in the "planet" Media Library root-level directory would have its filename set to "unicorn.jpg", its media_library_directory set to "/planet/" and its is_directory field set to false. That "planet" directory would have its filename set to "planet", its media_library_directory set to "/" and its is_directory property set to true.
We're putting the finishing touches on our forums. If you're one of the original recipients of this email, you'll receive a separate invitational email. Otherwise, please contact us and we'll make sure to send your way as well.
If you have any questions, concerns or suggestions, send them to api-inquiry@verticalresponse.com
To read previous editions of the API Newsletter go to VR Labs website and then to news section.
In This Issue
Question of the Month
Q: What's the best way to get started using the API?
A: The best way to get started is to familiarize yourself with the UI (front-end). You can create a free VerticalResponse account and get 25 free credits as well. Play around with creating email campaigns, creating lists and getting reports back from campaigns. After that the meanings of the available methods will become more apparent (e.g., appendFileToList() and createEmailCampaign()). But at any time if you have any questions, please send them over to api-support@verticalresponse.com
Enhancements
We will be changing our SSL certificates to provided a greater level of assurance for certain SOAP toolkits. We have not determined when we will make these changes, but we wanted to keep you informed on this possible change. We will be contacting you directly in advance before these changes are made.
Did you know?
To avoid a link being tracked, you can use 'nr_' in front of the URL. This is mostly helpful when you are having re-direction issues for a specific link. For example:
<a href="nr_http://..."></a>