Guide du développeur

Apprenez comment configurer et utiliser nos API ouvertes
afin d'intégrer librement Deskero à toute autre solution de logiciel !

Knowledge Base areas

List

Get a paginated list of knowledge base areas

GET https://api.deskero.com/knowledgeArea/list

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

URL parameters

Field name Value Required Default
page int value for page to show false 1

Example request

$ curl https://api.deskero.com/knowledgeArea/list \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"knowledge base": {
		"totalRecords": 50,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": "https://api.deskero.com/knowledgeArea/list?page=2",
		"records": [
			See knowledge base area detail
		]
	}
}

Search

Search a knowledge base area

GET https://api.deskero.com/knowledgeArea/list

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

URL parameters

Field name Value Required Default
page int value for page to show false 1
{{fieldName}} a value to search false

Example request

$ curl https://api.deskero.com/knowledgeArea/list?area=Sign in\ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"knowledge base": {
		"totalRecords": 1,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": null,
		"records": [
			See knowledge base area detail
		]
	}
}

Detail

Show a single knowledge base area

GET https://api.deskero.com/knowledgeArea/{{knowledgeBaseAreaId}}

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeArea/51cd8af3e4b0e90b324ab778 \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"id": "51cd8af3e4b0e90b324ab778",
	"area": "Sign in",
	"groupId": "52b423c3e4b04b021e45b660",
	"insertDate": 1372424947524
}

Create

Create a new knowledge base area

POST https://api.deskero.com/knowledgeArea/insert

Headers

Header Value
Authorization Bearer {{bearer}}
Content-Type application/json
clientId {{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeArea/insert \ 
	-v \
	-H "Content-area: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X POST \
	-d '{
		"area": "Sign in",
		"groupId": "52b423c3e4b04b021e45b660"
	}'

Example response

Created knowledge base area id

{
	"id": "51cd8af3e4b0e90b324ab778"
}

Update

Update a knowledge base area

PUT https://api.deskero.com/knowledgeArea/update/{{knowledgeAreaId}}

Headers

Header Value
Authorization Bearer {{bearer}}
Content-Type application/json
clientId {{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeArea/update/51cd8af3e4b0e90b324ab778 \ 
	-v \
	-H "Content-area: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X PUT \
	-d '{
		"area": "Sign in",
		"groupId": "52b423c3e4b04b021e45b660"
	}'

Example response

Updated knowledge base area id

{
	"id": "51cd8af3e4b0e90b324ab778"
}

Delete

Delete a knowledge base area

DELETE https://api.deskero.com/knowledgeArea/delete/{{knowledgeAreaId}}

Headers

Header Value
Authorization Bearer {{bearer}}
Content-Type application/json
clientId {{clientId}}

Example request

$ curl https://api.deskero.com/knowledgeArea/delete/51cd8af3e4b0e90b324ab778 \ 
	-v \
	-H "Content-area: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef" \
	-X DELETE

Example response

Deleted knowledge base area id

{
	"id": "51cd8af3e4b0e90b324ab778"
}

Fields

Field name Description
id auto-generated id
area unique area name
groupId group's id
insertDate insert date timestamp
Fermer