Requirements
- XML/HTTP Programming Knowledge
- SSL Support
- Internet Connection
- Premium or Ultimate Plan
Obtain your API Key
API keys are provided to all businesses with premium & ultimate plans under business settings. It’s easy to get an API key, you just have to sign in or sign up with Apptivo and go to Business settings -> API Access. These keys can be pasted directly into your Word press plugin, or inserted into your API code. No activation is required.
Steps to find your keys
- Go to the Apptivo Business Settings.
- Click “API Access” from left navigation panel.
- On the API Access page at the right side, get an API Key and Access Key.
- Note: If you want to regenerate the current key, you may use “Regenerate” blue button.
Interested in developing & selling Apptivo applications? Contact us for a developer key.
Authentication
Authentication is quite simple once you have your keys. You’ll simple need to include the parameters of “apiKey” and “accessKey” along with each API request you make. These values can be sent via GET or POST based on your preference. On a side note the Apptivo system uses a session key based authentication system, so you will not see the API/Access key passed through with requests inside of the App. For advanced implementations you may also choose to build a custom SSO or login pages and authenticate using the same sessionKey approach.
Building Your First App
We’ve provided some simple references within this guide itself for the most common Apptivo apps, but this is nowhere near a complete reference. Once of the complexities of Apptivo is the powerful field configuration available to each account, this means the object structure is unique for each app in every business. As you configure the Apptivo apps, there are pages within the settings that dynamically print out the API methods and JSON structure for that app based on current configuration. You can use these as a starting point, but our recommended development approach is to mimic API calls made by the system.
If you’d like to see some completed examples, we have some simple connectors available in our php library on Github.
