Interacting with Particeep Plug's API via the Swagger interface

Why Swagger?

With the application Swagger you can:

• send requests directly to our API to get information related to several parameters of your platform (like email addresses for example).

⚠ WARNING: 

• The Swagger is a tool to be handled with precision as it directly impacts the information related to your platform. 
• We formally advise against any POST, PUT or DELETE request if you are using a white label platform (this can desynchronize data with the complementary database linked to the white label).
• Particeep is not responsible for any change or loss of information related to an action on the Swagger other than a GET and any modification requiring an action from Particeep will be charged according to our professional services grid

How to get started with the Swagger

1

Go to plug.particeep.com/swagger

2

Log in with your credentials

3

That's it! You are on your Swagger platform

Interacting with the API through the Swagger is done in the Endpoints. In this section, all the URLs for interactions with the API are visible. These URLs are accompanied by a method (GET, POST, PUT, DELETE) and a description of the URL action.

The different methods perform different functions on the database: 

• GET: Retrieve values from the database
• PUT & POST: Add or modify values on the database
• DELETE : Delete values from the database

In order to interact with a particular endpoint, all you need to do is:

1

Click on the endpoint of your choice.

2

Click on the button Try it out

3

You can, if you wish, change the JSON values in the input field body.

4

Click on Run

5

The JSON response will be in the field response body, which will allow you to copy the result