Welcome to Cikisi 2.0 API.

Here you can find all available requests to our API.

Quick reference

These parameters are always necessary, not only when signing in.

Headers Optional
access-token false
token-type false
expiry false
uid false
client false

Questions/Comments

If you have any questions or comments, please contact our service desk at

servicedesk@cikisi.com

DISCLAIMER

{{variables}} are just there to pinpoint that you have to use your own values or values that we agreed upon such as {{API-url}} and {{VERSION}}.

THIS IS BY NO MEANS AN ENVIRONMENT.

Authentication process

In the response headers(if authentication was successful) these five parameters can be found:

  • access-token
  • token-type
  • expiry
  • uid
  • client

These five parameters are REQUIRED to make further requests to our API. These should be sent in the request headers.

These parameters should be included(in the headers) in every request made to our API.

These parameters are always necessary, not only when signing in.

Please check the image below.

General Parameters

  • per_page

The per_page parameter allows you to configure the maximum amount of hits to be returned

  • page

The page parameter defines the Items that are published after that date.

  • date_from

Date from defines Items that are published after that date.

(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)

  • date_to

Date to defines Items that are published until that date.

(When publication date is not available in the orignal page, or not well identified by Cikisi, then the publication date is linked to the creation date)

  • sort_by

Sort by defines in which way you want to sort fetched Items: [publication_date, created_at, relevance, engagements, views]

  • sort_direction

Sort direction defines in what order to view the items: [ASC, DESC]

  • metadata

The value by default (metadata=0) allows you to receive the items with their basic metadata: [ id, title, description, content, publication_date, created_at, source information]

Metadata=1 allows you to receive the items with all the metadata including [Name Entities and keywords, collections, tags, geolocations]

Auth

User Authorization

POST /auth/sign_in
{{CIKISI_URL}}/api/auth/sign_in
PARAMS

BODY formdata

email
{{Email}}
password
{{Password}}


Example Request
/auth/sign_in
curl --location --request POST '{{CIKISI_URL}}/api/auth/sign_in' \
--form 'email={{Email}}' \
--form 'password={{Password}}'

Collection Items

GET /v2/collections/:id/items
{{CIKISI_URL}}/api/v2/collections/:id/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PATH VARIABLES

id
{{collection_id}}
PARAMS

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/collections/:id/items

Theme Items

Topic Items

GET /v2/topics/:id/items
{{CIKISI_URL}}/api/v2/topics/:id/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PATH VARIABLES

id
PARAMS

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/topics/:id/items
GET /v2/themes/:id/items
{{CIKISI_URL}}/api/v2/themes/:id/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PATH VARIABLES

id
{{theme_id}}
PARAMS

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/themes/:id/items

Source Items

GET /v2/sources/:id/items
{{CIKISI_URL}}/api/v2/sources/:id/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PATH VARIABLES

id
{{source_id}}
PARAMS

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/sources/:id/items

Item Tags Items

GET /v2/item_tags/items
{{CIKISI_URL}}/api/v2/item_tags/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PARAMS

name[]
{{Tag Names}}
per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/item_tags/items

Source Categories Items

GET /v2/source_categories/items
https://www.wmt.cikisi.com/api/v2/source_categories/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PARAMS

name[]
{{Categories Names}}
per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/source_categories/items

Geolocated Items

GET /v2/geolocated/items
{{CIKISI_URL}}api/v2/geolocated/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PARAMS

radius
{{Radius}}

ex. "10km"

lat
{{Latitude}}

ex. 123.123

lon
{{Longitude}}

ex. -123.123

keywords
{{Keywords}}
per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/geolocated/items

(Cikisi Saved) Searches Items

GET /v2/searches/:id/items
{{CIKISI_URL}}/api/v2/searches/:id/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PATH VARIABLES

id
PARAMS

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/searches/:id/items

Similar Items

GET /v2/similar/items
{{CIKISI_URL}}/api/v2/similar/items
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PARAMS

title
{{title}}

Check for similar items based on title of Item

content
{{content}}

Check for similar items based on content of Item

per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/similar/items

Search Items

GET /v2/search
{{CIKISI_URL}}/api/v2/search
HEADERS

access-token
{{Access-Token}}
token-type
{{Token-Type}}
client
{{Client}}
expiry
{{Expiry}}
uid
{{Uid}}
PARAMS

keywords
{{keywords}}
per_page
{{10}}
page
{{0}}
date_from
{{Date}}
date_to
{{Date}}
sort_by
{{Sort}}
sort_direction
{{Sort Direction}}


Example Request
/v2/search

Demande de démonstration