System-Wide SettingsHomepage SettingsBoxes and Sidebar
Pop-up WidgetEmbedded WidgetPop-up Question FormAPI Tools
Question FormSearch Form
General ChangesHomepageAnswer PageSidebarSystem BoxesBrowse & Search Pages
This is the "API Tools" page of the "Customizing LibAnswers v1" guide.
Alternate Page for Screenreader Users
Skip to Page Navigation
Skip to Page Content

Customizing LibAnswers v1  

Customizing the look and feel of your LibAnswers system.
Last Updated: Feb 10, 2017 URL: http://help.springshare.com/customizela Print Guide RSS UpdatesEmail Alerts

API Tools Print Page
  Search: 
 
 

What is the API Utility?

Tools menu > API Utility

The API Utility allows you to pull data from your system and display it anywhere:

  • websites / blogs,
  • course/learning management systems,
  • in your guides,
  • anywhere else you can think of that accepts iframes or JavaScript!
 

Embed a List of Answers

Embed a list of answers filtered by Sub-Type, such as "Featured Answers," "Recent Answers," assigned to a particular topic, or even a list that you choose.

Options vary by sub-type, but all options return lists of questions that match your criteria, as well as details and answers, if you choose to include them.

Request Format type:

    • Use HTML if you're going to run the API through a webscript embedding within <iframe> tags;
    • Use JavaScript for simple widget-like embedding (copy/paste);
    • Use JSON if you're going to run the API through a script.

API Answers Choices


 

Embed LibAnswers Topics

Options:

  • Sub-Type - How do you want your Topics to display?
    • Cloud?
    • Dropdown Menu?
    • Formatted/Bulleted List?
    • Unformatted/Unbulleted List?
  • Topic Order - How do you want the Topics to display?
    • Alpha Order?
    • By Number of Answers assigned to that Topic?
      • Most to Least
  • Show Answer Count (Cloud/Dropdown Only) - Display the number of Answers assigned to that Topic?
  • # Items to Show - Limit number of results shown;
  • Request Format type:
    • Use HTML if you're going to run the API through a webscript embedding within <iframe> tags;
    • Use JavaScript for simple widget-like embedding (copy/paste);
    • Use JSON if you're going to run the API through a script.

Topics API Choices

 

Embed LibAnswers Boxes

Box Types:

  • More Ways to Ask Questions Box
  • Info/Alert Box 
  • Chat Box

Options:

  • Include LibAnswers CSS - Select whether you want the box to be styled as it appears within LibAnswers;
  • Request Format type:
    • Use HTML if you're going to run the API through a webscript embedding within <iframe> tags;
    • Use JavaScript for simple widget-like embedding (copy/paste);
    • Use JSON if you're going to run the API through a script.

API Boxes Choices

 

Embed a Single Question and Answer Pair

Embed a single public question and its answer, including links, files, and media:

Options:

  • Question ID: the ID number of the public question you want to display. Find the ID number in the Knowledge Base Explorer.
  • Include CSS: choose yes here if you would like the result styled the same way it is styled in LibAnswers.
  • Request Format type:
    • Use HTML if you're going to run the API through a webscript embedding within <iframe> tags;
    • Use JavaScript for simple widget-like embedding (copy/paste);
    • Use JSON if you're going to run the API through a script.

single qa pair api call

 

Embed Results of a Query

Embed a list of questions that result from a search query:

Options: 

  • Enter your search term.
  • Determine the number of results.
  • Request Format type:
    • Use HTML if you're going to run the API through a webscript embedding within <iframe> tags;
    • Use JavaScript for simple widget-like embedding (copy/paste);
    • Use JSON if you're going to run the API through a script.

Query API call options

Description

Loading  Loading...

Tip