Getting Started with Kissflow APIs

Updated 2 weeks ago by 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, modification of forms in flows, etc. 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

As a Kissflow user, you can find all documented APIs by accessing the URL: {account-domain}.kissflow.com/apidocs/1/

For example, if your account domain is stark-industries.kissflow.com, then you can access all the Kissflow APIs by searching the URL: https://stark-industries.kissflow.com/apidocs/1/

Once you’re able to access the API documentation, you can then search for a particular API. You can also execute a specific API command using the internal API tester or use cURL commands. Here is an example of how to use cURL argument to generate a new API key:

curl -X POST "https://stark-industries.kissflow.com/user/1/{account_id}/api/" 
-H "accept: application/json"
-H "X-Api-Key: {API_Key}" 
-H "Content-Type: application/json"
-d "{ \"Name\": \"string\"}"


How did we do?