About the SEO Keyword Suggestions Service Plugin

Important:

  • To test an app with the SEO Keyword Suggestions service plugin, please contact us. Our team can add the app to the SEO Setup Checklist flow for testing.

  • When developing websites or building apps with Blocks, use Velo service plugins.

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 method's description for details about those actions.

Using the SEO Keyword Suggestions 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.

Before you begin

It's important to note the following before starting to code:

  • This service plugin isn't yet supported by the CLI.

Get started

To enable Wix to communicate with your app:

  1. Go to Extensions in your app's dashboard.

  2. Click Create Extension in the top right corner.

  3. Find SEO Keyword Suggestions and click + Create.

  4. Use the JSON editor to create the extension's configuration file. Configure the parameters by referencing the table below or the Documentation section to the right of the editor. Provide the following configuration for your app:

NameTypeDescription
baseUristringRequired. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI. For example, to call the Get Quota endpoint at https://my-seo-suggestions/v1/get-quota, the base URI you provide here is https://my-seo-suggestions.com.
upgradeUrlstringURL 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.
supportedCountryCodesarrayRequired. List of countries you support for SEO analysis. 2-letter country code in ISO-3166 alpha-2 format.
quotaEnabledbooleanWhether there is a quota limit in the service. When set to true, include the quota object in responses.
landingPageUrlstringRequired. Your website's landing page.

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.

See also

Did this help?