In Peliqan you can define and publish API endpoints, in order to share data with partners, customers etc.

Note that these API endpoints can also be used to capture incoming webhook events. Alternatively you can use the built-in webhook URL for your account to capture incoming webhooks events.

Publishing an API endpoint

In Peliqan, go to the Build section, and click the “+” icon when hovering over “API endpoints”:

Add a new endpoint and link it to a Python script of type “API handler”. See below on how to write a low-code Python script to handle the API requests.

Choose the Authorization:

• JWT Authorization: create a JWT web token under Settings > Security, and use this in the Authorization header to authenticate when consuming this API endpoint.
• Public: no authorization, use this when you implement your own authentication scheme with e.g. multiple API keys (see below)

The full URL of your API endpoint is shown on the API endpoint detail screen, as you can see in the above screenshot.

Adding a Python script to handle API requests

In Peliqan, go to the Build section, and click the “+” icon when hovering over “Apps”. Add a script (app) of type “API endpoint handler”: