View Categories

REST API – Introduction

1 minutes

Take advantage of 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 the library of your choice 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": {
    // ...
  }
}

Negative Response #

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

Operations Summary #

Operation Method Description
getchallenge GET Get a connection token
login POST Log in
logout POST Log 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 Query related lists
add_related POST Add a relationship between entities
getPicklistValues GET Retrieve the values of a dropdown list
setPicklistValues POST Modify the values of a dropdown list
FileUpload POST Upload a file
files_retrieve GET Retrieve a file

Related References 🔗 #