Version: 1.0.0

Getting Started

Potion is essentially a collection of social features handled by API endpoints. The first thing to do is to create your own project on api.potion.social.


Following project creation

Once created, you will have access to an administation interface to visualize any data created using Potion's APIs. This administration could be seen on the potion subdomain you've chosen (e.g. https//your-name.potion.social). It's unique and will be yours as long as you wish.

Start using API endpoints

Now that you have created your brand new project, it's time to add some data using the API endpoint of your choice. To do that you first have to create a ApiTokenAPI.

Just go to your project URL home page and create your ApiTokenAPI by pressing the create button. You will also get an API Secret.

Be careful, it will only be displayed once and it is mandatory to have both API Token and API Secret to use endpoints.

You can also create this token in the API keys section in the Configuration section of your administration interface.

You can create more tokens if you wish to split usage for security reasons and also restrict tokens to some domains.

Your very first Potion API call

With your new token, you can now start using Potion's APIs. For example purpose, lets ping Potion API.

curl -X GET \
https://YOUR_PROJECT_DOMAIN.potion.social/public-api/v1/ping \
-H 'Api-Key: YOUR_API_KEY' \
-H 'Api-Secret: YOUR_API_SECRET' \
-H 'Content-Type: application/json' \

If you succeed to make that API Call, your will see a beautiful pong response.