/freescout-knowledge-api

Module for FreeScout to make the public content in the knowledge base available through an API

Primary LanguagePHPMIT LicenseMIT

Knowledge base API module for FreeScout

This module adds the option to add a public API for the FreeScout knowledge base (module).

Requirements

Installation

  1. Download the latest module zip file via the releases card on the right.
  2. Transfer the zip file to the server in the Modules folder of FreeScout.
  3. Unpack the zip file.
  4. Remove the zip file.
  5. Activate the module via the Modules page in FreeScout.

Update instructions

  1. Download the latest module zip file via the releases card on the right.
  2. Transfer the zip file to the server in the Modules folder of FreeScout.
  3. Remove the folder KnowledgeBaseApiModule
  4. Unpack the zip file.
  5. Remove the zip file.

Contributing

Feel free to add your own features by sending a pull request.

Get knowledge base categories in a mailbox

curl "https://example.com/api/knowledgebase/1/categories?locale=en" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json; charset=utf-8' \
-d $'{}'

Get articles in a category

curl "https://example.com/api/knowledgebase/1/categories/1?locale=en" \
     -H 'Accept: application/json' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{}'

LICENSE

MIT