Using the Mozenda Web Services Rest API, customers can programmatically connect to their Mozenda account. This provides complete automation capabilities for setting search parameters, gathering results, updating collections, etc. This connection is made by sending a standard Http request that includes variables and other settings for interacting with the system.
Configuring your account to be accessible via the API is a simple process:
1. Login to your account at http://account.mozenda.com/login
2. Click the Account link located in the top right corner of the web page.
3. Click the Users tab in the Account area.
4. Click the wrench symbol for the user you would like to configure an ‘API Web Service Key’ for.
5. Look for the ‘API Web Service Key’ section and then click Generate a New Key. You will be required to provide this key in all requests to the API.
6. Learn the syntax of the API requests using the documentation below and you are ready to go!
After you have enabled your account for API access you will want to determine what functions you need to accomplish programmatically. Most of the actions you can perform via the Web Console can also be initiated through the API. Use the rest of this document as a reference for the different functions that you will need to perform.
Next, each request made to the API requires your Web Service Key (described above) to authenticate your account. This value is passed in using the WebServiceKey parameter:
Next, each request needs to provide the Service parameter.
This parameter specifies the version of the API being used.
Right now the only accepted value is Mozenda10:
Finally, each request needs to provide the Operation parameter.
This parameter tells the API what operation you want performed.
A list of the available operations follows, along with a sample URL showing how to use the operation.
Optional: Each response to an API request is returned in XML format by default. Alternatively, an API response can be returned as JSON by specifying JSON for the value of the optional ResponseFormat parameter.
Important Note: All API requests must comply with the specification for URLs RFC 1738.
This means some parameters need to be encoded before they are passed via the API. For Example, if you wanted to add a ViewParameter.Name parameter with the value of “Sport Camera” to your View.GetItems API call,
then the correct encoding for this call is “ViewParameter.Name=Sport%20Camera”, because spaces are not allowed in URLs and should be replaced with a %20 in the encoding step of your process.