About the SEO Keyword Suggestions Service Plugin

As an SEO Keyword Suggestions provider, you can integrate with Wix to enable Wix users to optimize their SEO strategy.

The integration is done via an app in the Wix App Market and by implementing the SEO Keyword Suggestions service plugin. After the app is installed on a site, Wix triggers a call to your service when specific actions are taken on the site. Refer to each function's description for details about those actions.

Using the service plugin, you can design your app to:

  • Enable Wix users to check the SEO strength of a potential keyword.
  • Suggest similar keywords to compare SEO strength.
  • Provide analysis about the suggested keywords based on search volume and ranking difficulty.
  • Update Wix users about remaining credit in their plan.

Terminology

  • Suggested keywords: Keywords suggested by your app to compare SEO strength of potential keywords and enable optimization of SEO strategy.
  • Quota: Details of the plan such as credit remaining in terms of number of searches left, total available searches, and start and end dates of the quota cycle.

Get started

Follow these steps to begin implementing your service plugin.

Choose a framework

You can implement this service plugin with the following frameworks:

Configure your service plugin

To configure and customize your plugin, you need to provide important information in the service plugin configuration file. You can configure your plugin in the Wix Dev Center. For details, see SEO Keyword Suggestions Extension Configuration.

Define handler functions

Use seoKeywordSuggestions.provideHandlers() to define the following handler functions that implement your custom business logic. Make sure you define all required functions.

FunctionRequired
getQuota()Yes
listSuggestedKeywords()Yes

Code examples

Below is an example for implementing the SEO Keyword Suggestions service plugin in your code.

CLI: Basic code structure

This is the basic code structure for implementing the SEO Keyword Suggestions service plugin with the Wix CLI:

Copy

Self-hosted: Basic code structure

This is the basic code structure for implementing a self-hosted SEO Keyword Suggestions service plugin:

Copy

See also

Was this helpful?
Yes
No

Extension Config

To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.

Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
baseUristring

Base URL of your SEO implementation. Wix sends API requests to endpoints implemented using this URL.

landingPageUrlstring

Your website's landing page.

quotaEnabledboolean

Whether there is a quota limit in the service. When set to true, include the quota object in responses.

supportedCountryCodesArray<string>

List of countries you support for SEO analysis. 2-letter country code in ISO-3166 alpha-2 format.

upgradeUrlstring

URL of the page where users can purchase a paid plan. Wix offers a link to this page when you respond with a value of false in quota's paidPlan property.


Was this helpful?
Yes
No