Getting started with Kissflow APIs
Modified 2 years ago
Abhiram
Introduction
Application Programming Interface (API) is a set of simple functions and procedures that allows different applications to communicate with each other.
Kissflow APIs help you remotely accomplish many operations in Kissflow, such as the creation of new flows, submission of new items, and modification of forms in flows. As these APIs are built as RESTful Web service, requests made to a resource's URI will elicit an HTTP response with a payload formatted in JSON format.
Using API Keys to authenticate API calls
All Kissflow APIs require an API Key for header authentication. You can follow these instructions to create an API Key in your Kissflow account.
Notes to remember:
- API Keys are created at the individual user level and not for the entire account.
- Users can create multiple API Keys from a single account.
- All API Keys must be manually deleted by the user if they are no longer in service.
- API Keys should be kept private as they carry important information about your identity.
HTTP methods for RESTful services
Kissflow APIs use appropriate HTTP verbs for every action.
HTTP Method | Description |
GET | Retrieves a representation of a resource |
POST | Creates new resources and performs resource actions |
PUT | Updates resource data |
DELETE | Deletes resources |
Decoding API responses
HTTP status codes help identify failures in the server’s response to your API call. In general, status codes in the 2xx range mean success, the 4xx range means there was an error in the provided information, and those in the 5xx range indicate server-side errors.
Here are a few of the commonly used HTTP status codes that you’ll encounter while using Kissflow APIs:
HTTP Status Codes | Description |
200 | Success |
400 | Bad request |
401 | Unauthorized request |
403 | Forbidden URL |
404 | URL not found |
500 | Internal server error |
Accessing Kissflow APIs
You can find all the resources regarding Kissflow interfaces by accessing the link: developers.kissflow.com.
You can easily navigate and search specific APIs using the search bar. You can execute specific APIs using the native API tester. To do this, click the Try It button and enter your unique API Key.
API calls can be tested using cURL, Node, Ruby, JavaScript, or Python arguments.
