Integrating Planner into your app or website can begin as soon as you create a Planner account, requiring only three steps:

1. Obtain your API keys so Planner can authenticate your integration's API request
2. Install a client library so your integration can interact with the Planner API
3. Make a test API request to confirm everythin is up and running

1. OBTAIN YOUR API KEYS


Planner authenticates your API requests using your account's API Keys. If you do not include your key when making an API request or use one that is incorrect or outdated, Planner will then return an authorization error.


You can find the private key under the user settings. Private keys will always start with the preffix priv_ for users clarity.


If you can't see your keys in the user profile, this means that you don't have Planner API access. Check our subscriptions for further information.


2. INSTALL A CLIENT LIBRARY


3. MAKE A TEST API REQUEST


To check that your integration is working correctly, make a test API request using your test secret key to get a list of available plans.


You have to replace <YOUR_PRIVATE_KEY> with your own key.

curl "https://highwayservices.smartmonkey.io/api/v1/plans\
?private_key=<YOUR_PRIVATE_KEY>"

If everything worked fine you should receive as a return a paginated list of your plans. You are ready to begin integrating Planner in your system.

Did this answer your question?