View Categories

REST API – Introduction

1 minutes

Take advantage of the REST APIs exposed over HTTP(s) to push or pull data from Kafinea and integrate it with third-party applications. You are free to choose whichever library you prefer to work with these APIs.

General Principles #

The Kafinea API is a REST API: you communicate directly with your Kafinea instance, and each request is unique and independent. Nothing is cached.

  • Protocol: HTTP(s)
  • Methods: GET and POST
  • Response format: JSON
  • Base URL: https://apps.kafinea.com/{VotreInstance}/webservice.php

Response format #

Positive response #

{
  "success": true,
  "result": {
    // ...
  }
}

Rejection #

{
  "success": false,
  "error": {
    "message": "[STRING]",
    "code": "[STRING]"
  }
}

Summary of operations #

Operation Method Description
getchallenge GET Get a login token
login POST Login
logout POST Sign out
extendsession GET Extend the session
listtypes GET List available modules
describe GET Describe the fields of a module
create POST Create an entity
retrieve GET Retrieve an entity
update POST Update an entity
delete POST Delete an entity
query GET Query the database
query_related GET View related lists
add_related POST Add a relationship between entities
getPicklistValues GET Retrieve values from a drop-down list
setPicklistValues POST Change the values in a drop-down list
FileUpload POST Upload a file
files_retrieve GET Recover a file

Related references 🔗 #