Getting Started with the APIJump right in and get started. Make sure you have the current version of your wrapper of choice and are connecting to the current endpoint.
ConnectingLet us take care of all the details for you and use one of the wrappers that we provide. If that's not possible, then:
- Find a suitable XML-RPC library. If you're using PHP, we strongly recommend XML_RPC2.
- Roll your own HTTP GET / POST requests. Connect to the current API endpoint and retrieve data in one of our supported data formats.
Data FormatsChoose from several options for formatting returned data.
- Use one of our provided wrappers and use native data structures.
- XML-RPC: The API system is built around PEAR::XML_RPC2. You can use any XML-RPC class or library you like. We strongly recommend XML_RPC2.
- Serialized Data: The API currently supports XML, JSON and serialized PHP structures.
Caching ResultsMyNewsletterBuilder caches a large amount of data internally to speed up requests. The API makes extensive use of these data caches as well. In the documentation, methods that may return cached results are clearly marked as such. When the cache expires, the API will return (and re-cache) a fresh result set for you.
By caching this data on your server (instead of requesting it again from the API), you can further increase the speed and responsiveness of your application.
Error CheckingPlease make sure you are checking for error values in the returned data. Whenever possible, the API will return an error code and status message when something unexpected happens. Your application can handle errors gracefully when they come up.
PluginsWe may have a plugin for your specific CRM, CMS, blog, etc... product. If you you'd like to see something supported, or if you have a plugin you would like to share, let us know.