Using the API

ezyFAQ allows for the use of a public API on our large plan.

The public API is for advanced users and allows for the querying of existing and inserting of new FAQ’s via HTTP POST.

By default, the public API is disabled for security. After setting an API key, the public API becomes active and can be used.

The two API end points are:

Inserting new FAQ’s [POST] https://.ezyfaq.com/api/new

Querying existing FAQ’s

[POST] https://.ezyfaq.com/api/get

Querying existing FAQ by ID or permalink

[GET] https://.ezyfaq.com/api/get/{id or permalink}

Authentication

To use the API you will need to ensure the auth-token HTTP header is set to the same authentication token which you have set in the ezyFAQ settings page.

Inserting FAQ’s

A sample minimum JSON Object for inserting a new FAQ. All fields below are required for all new FAQ’s.

{
    "title": "This is the title of the new FAQ",
    "body": "### This is the body text which is in Markdown format",
    "publishedState": true,
    "authorEmail": ""
}

Note: A valid authorEmail needs to be supplied. If an author with the supplied email does not exist, the API call will fail.

All supported properties:

'title': {'type': 'string','required': true}
'body': {'type': 'string','required': true}
'publishedState': {'type': 'boolean','required': true}
'permalink': {'type': 'string','required': false}
'keywords': {'type': 'string','required': false}
'authorEmail': {'type': 'string','required': true}
'featuredState': {'type': 'boolean','required': false}
'seoTitle': {'type': 'string','required': false}
'seoDescription': {'type': 'string','required': false}

Querying existing FAQ’s

A sample minimum JSON Object for querying existing FAQ’s. All fields below are required for all new FAQ’s.

{
    "startRange": "2015-09-05",
    "endRange": "2016-11-10"
}

Note: Dates are formatted: yyyy-mm-dd

All supported properties:

'startRange': {'type': 'string','required': true}
'endRange': {'type': 'string','required': true}

Querying existing FAQ by ID or permalink

Retrieving a specific FAQ can be done by sending a GET request to: [GET] https://.ezyfaq.com/api/get/{id or permalink} with the ID or permalink of the FAQ you want. The following JSON Object is returned:

{
    "_id": "580ea42294bce3a47b94e754",
    "title": "How do I upload a file?",
    "body": "1. Login to [ezyFAQ](https://ezyfaq.com/login)\r\n2. Navigate to the `Admin > Files` menu\r\n3. Click the `Select file` button and browse to the file you want to upload\r\n4. Click the `Upload file` button to complete the process",
    "permalink": "how-do-i-upload-a-file",
    "publishedState": "true",
    "keywords": "settings, upload, files",
    "publishedDate": "2016-10-25T00:15:30.534Z",
    "lastUpdated": "2016-11-07T04:30:03.400Z",
    "lastUpdateUser": "Support - ",
    "author": "Support",
    "authorEmail": "",
    "viewcount": 288
}