Skip to content

Getting started

API keys

On this page

A site's Keys tab holds the keys your shop and other tools use to connect to Searcio. The WordPress plugin usually sets them up itself when you connect, so you rarely need them. This is also where you rotate the keys and remove the site.

You open the tab under Sites > Northline Outdoor > Keys.

The Keys tab of Northline Outdoor with the search key, write key, read key and write secret, and the section for removing the site

The keys at a glance

The tab shows three keys and the write secret. They apply to this one site only.

Key What it is for Keep it secret?
Search key The search box on your site uses it to search at Searcio. It starts with sk_. No. Your visitors' browser uses it, so it is safe for it to be public. It cannot change any content or settings.
Write key Your shop uses it to send its products and other content to Searcio. It starts with wk_. Yes. It belongs on your server only, for example in the WordPress plugin.
Write secret The password for the write key. Searcio only accepts content with both together. Yes, like a password.
Read key (MCP) For connecting an AI tool. It can read your statistics and search your products, but never change anything. It starts with rk_. Yes. Whoever has it can read your search statistics.

To copy a key, click the button with the copy icon to its right. A tick confirms that it is on the clipboard.

Where you enter the keys:

  • WordPress plugin: the search key, the write key and the write secret, on the plugin's Connection tab. See Connecting the site to your shop.
  • Your own software: the write key and the write secret on your server, the search key in the search box. See the REST API reference.
  • AI tool: the read key. How to connect an AI tool is described in the MCP server reference.

The write secret

Searcio does not keep the write secret in readable form, so it cannot show it again. The tab shows it exactly once: right after you added the site or rotated the keys. At that moment it is highlighted, with a note telling you to copy it now.

As soon as you reload or leave the page, it only shows (no longer retrievable). So copy the write secret straight away and enter it where it is needed, such as in the WordPress plugin.

If you have lost the write secret, rotate the keys. This changes all of the site's keys, not just the write secret.

Rotating the keys

Rotate the keys if the write secret has been lost, or if a write key, write secret or read key may have fallen into the wrong hands, for example because a member of staff with access has left the company.

  1. Open Sites > Northline Outdoor > Keys.
  2. Click Rotate keys.
  3. Read the Rotate this site's API keys? dialog and click Rotate keys.
  4. Copy the new keys. The new write secret is highlighted and is shown this one time only.
  5. Enter the new keys everywhere the old ones were used.

The Rotate this site's API keys dialog, with the note that the current keys stop working immediately

Owners, managers and editors can rotate the keys, see Roles and permissions.

What happens when you rotate

The search key, the write key, the write secret and the read key are all replaced at once, and the old ones stop working immediately. Until you have entered the new keys:

  • Searcio no longer returns results to the search box on your site, because the old search key is no longer valid;
  • Searcio no longer accepts content from your shop, so new and changed products do not appear in the search;
  • an AI tool using the old read key loses its access.

The content in the search index and all of the site's settings are kept.

In the WordPress plugin, enter the new keys like this:

  1. In the WordPress admin, go to Searcio > Connection.
  2. Open Advanced: manual key entry / rotate keys and enter the new search key, write key and write secret.
  3. Click Save connection, then Test connection.

Have the WordPress plugin open before you rotate the keys. The search on your site is then only interrupted for as long as entering the keys takes.

Removing the site

The Remove site section is at the end of the tab. Move to Trash moves the site to the Trash after you confirm. The search index is kept until you delete the site permanently.

What happens to the site in the Trash, and how to restore it, is described under Removing a site.