Clappia provides RESTful APIs that allow you to send data directly to your Clappia apps using HTTP POST requests with a JSON payload. These APIs enable seamless integration between Clappia and other external systems, automating processes and enhancing data flow.
With public APIs, you can:
Submit data to Clappia apps programmatically.
Automate data entry and workflows.
Integrate external applications and services with Clappia.
Generating an API Key for Your Workplace
To use the public APIs, you need an API key specific to your workplace. The API key acts as an authentication token to ensure secure interaction with the APIs.
Steps to Generate an API Key
Go to Workplace Settings > Preferences tab > Select API Keys.
Click on Generate API Key. A unique API key for your workplace will be created.
Once generated, you will see the API key.
Important Notes:
Copy the API key and store it securely. If exposed, anyone with the key can interact with your Clappia apps.
Avoid sharing the API key publicly.
Once a key is generated, a default usage limit is applied automatically:
Free Plan: 1000 API calls per month. This limit cannot be increased unless you upgrade to a paid plan.
Paid Plans: Also starts with 1000 API calls per month. You can increase the limit by purchasing add-ons.
Increasing API Request Limits
If you need a higher API request quota you will need to purchase more API calls:
Go to Workplace Settings > Billing tab.
Click on your current plan.
On the right panel, under Add-ons, click Add an Add-on.
Select REST API (1000 REST API calls per month) from the dropdown.
Review other options to ensure no unnecessary add-ons are selected, then click Update and proceed with payment.
The pricing for each add-on will be visible during this process.
You can also monitor your current month's API usage directly from the Billings page.
Example Use Case: Submitting Employee Records
Here’s an example of how you can use the public APIs to push data into a Clappia app.
Scenario: Let’s say you have an employee management app in Clappia and want to push new employee records from your internal HR system.
In the screenshots below, we are pushing data to an app named "Employee Master" through the REST Api. At the end you'll find the submission in the same Clappia app.
Steps
Generate the API Key in Workplace Settings following the steps above.
Get your workplace ID within Workplace Settings itself. When no option is selected, on the right panel, you will have general workplace information displayed.
Identify the App ID of your Clappia app. You can find this in the app URL after "app/".
Identify the unique field names of the app fields in your Clappia app where the data should be inserted.
API Request (POST):
The JSON payload can be used in tools like Postman for testing API requests or in custom scripts (e.g., Python, JavaScript) for automation. It’s typically used by your team’s developers or IT team when integrating external systems with Clappia.
.svg){kind=small}
