Step 1 - Log into the Coveo Cloud V2 Platform for the First Time to Register your Identity
Step 2 - Get your Coveo Cloud V2 Platform Access Token
Now that the Coveo Cloud V2 platform recognizes your identity, you must get an access token with which to authenticate some of the REST API calls you are going to make during this tutorial (see Getting Your Coveo Cloud V2 Platform Access Token).
Step 3 - Create a Coveo Cloud V2 Organization
Once your organization has been successfully created, you can verify that your access token now has extensive privileges in this new organization (see Getting the Privileges of an Access Token). In particular, your access token should allow you to view and edit API keys and sources, and execute queries in your organization.
Step 4 - Create an API key
You will now generate an API key with very limited privileges, which you will use to authenticate your next few calls.
Create an API key using the following instructions (see Creating an API key):
- Authenticate the call using the access token you got at Step 2.
Assign the following privileges to this API key:
- Make sure this API key is
- Specify adequate values for the following parameters:
First Steps Tutorial)
Generated on 2017-09-25 for Alice Smith to try creating a source and performing a query.)
Remember you can only get the API key
value once, in the successful response body of its creation call.
Step 5 - Create a Source
A Coveo Cloud V2 organization becomes useful only when it has at least one source of content.
A source can be secured, meaning that this source contains permissions associated with each item. In this introductory tutorial, however, you will create a shared source, meaning that no permissions are associated with items, so that anonymous users can get all source items in their query results.
To minimize the crawling time, and to make your source quickly searchable, preferably select a website with less than 100 pages for this tutorial.
As soon as your source is created, it starts crawling the target website and processing items in the Coveo Cloud V2 indexing pipeline.
Step 6 - Perform a Query
When at least one source item is fully processed, you can start querying your index and getting results.
Step 7 - Delete the Coveo Cloud V2 Organization
Now that you have completed this tutorial, delete the Coveo Cloud V2 organization you created at Step 3, unless you want to perform further tests with this organization.