Create an API Key
Create an API Key
What is an API Key?
An API Key is a type of token that enables access to the SearchCloudOne REST API to perform search requests and manage files on your account.
Before you Begin
You need to Create an Index to search and manage using the API.
Creating the Key
Go to your Console and select the API Tab.
Set up Permissions
Search Cloud One uses a granular Permissions system for API keys for enhanced security.
API Keys are granted any of Read, Write and Delete Permissions to individual indexes.
- Read: ability to Search and Retrieve documents from the Index
- Write: ability to upload new documents to the Index
- Delete: ability to remove documents from the Index
Click New Set to create your first Permission Set.
Enter a name for the new Permissions Set and click Create.
In the Permissions Dialog, Add the Index you want to grant permissions to.
Check the relevant Permissions boxes and click Save
Create the Key
Click New API Key
Select the Permissions and Enter a name for the Key.
Click Create to create the Key; your new API Key is shown in the API Keys section.
This demo page was created with the WordPress plug-in, no programming was needed.
It demonstrates the use of filters to narrow the search without having to type a long query such as Title contains (Smith v Cotoco Freezing company) or Date Of Judgment contains (2016/01/21).
Try clicking the filter in the search bar, enter a Date of Judgment of 21 Jan 2016, click Apply.
PDF files were uploaded with custom properties created in Adobe Acrobat called Date of Judgment and Case Title. The files are automatically converted by Search Cloud One to HTML to allow multi-color hit-highlighting.
Try a search for – holden and fashion and ashi – click on the search result to view the document with each word of the search in a different color.
The 20 files in this demo are a small sample donated by Toma Legal Retrieve from their large collection of over 30,000 documents.
Other Search Demo pages
Classics – basic Boolean search
Cars Demo – faceted search