BWT Site Readiness: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Set up a site in Bing Webmaster Tools

A Wix user wants their site added to Bing Webmaster Tools, verified, and submitting its sitemap. Your app clears the readiness blockers one at a time, then submits the sitemap.

To set up a site:

1. Call Get Site Readiness. If status is READY, the site is connected, added, and verified, so continue from step 4.
2. If status is NOT_READY, act on the returned blockingReason:
   • NOT_CONNECTED: the site has no usable Bing connection. It was never connected, the connection was removed, or Bing no longer accepts the stored credentials. Connect a Microsoft account with the BWT Connection API.
   • SITE_NOT_PUBLISHED: have the Wix user publish the site before continuing.
   • DOMAIN_NOT_CONNECTED: Bing Webmaster Tools setup needs a connected domain. Have the Wix user connect one before continuing.
   • SITE_NOT_ADDED: the connection works, but the site isn't in the connected Bing account yet. Call Add Site. If the call fails with FAILED_PRECONDITION (SITE_NOT_INDEXABLE), have the Wix user allow search-engine indexing first.
   • SITE_OWNER_NOT_VERIFIED: the site is in the Bing account, but its ownership isn't verified yet. Call Verify Site. Verification runs synchronously against Bing, so allow up to a minute. A FAILED_PRECONDITION (MISSING_VERIFICATION) error means Bing didn't find the tag yet, so retry after a short wait.
   • Any other value: treat the site as not ready, and don't assume a next action. New blocking reasons can be added over time.
3. Call Get Site Readiness again after each successful action, and repeat until status is READY. Read the current blockingReason each time instead of reusing an earlier one, because a response reports only the first step that's still blocking.
4. Call Submit Sitemap. The sitemap, which is generated and hosted by Wix, is submitted to the connected Bing account. Bing processes sitemaps asynchronously, so check the processing state later with List Sitemaps.

Readiness doesn't track the sitemap, so call Submit Sitemap yourself once the site is READY.

Show the site's sitemaps

Your app has a settings page that shows the sitemaps submitted to Bing for the site and how Bing processed them.

To show the sitemaps:

1. Call List Sitemaps. Each item has the sitemap's url, and the details Bing reports for it: type, status, submittedDate, lastCrawledDate, urlCount, fileSize, and compressed. If the call fails with FAILED_PRECONDITION (SITE_PROPERTY_NOT_OWNED), set the site up first, as described in Set up a site in Bing Webmaster Tools.
2. Present each sitemap. Show a field only when it's set: Bing leaves a field unreported, for example before it first reads a sitemap it reports status Pending, and an unset field means "not reported", not zero.
3. When a sitemap's type is Sitemap Index, call Get Sitemap with its url to get the sitemaps it lists in childSitemaps. A NOT_FOUND (SITEMAP_NOT_FOUND) error means no sitemap with that URL was submitted for the site.

Remove the site's Bing verification

A Wix user wants Wix to stop managing their site in Bing Webmaster Tools, for example before handing the site over to someone else.

Clear Verification removes the msvalidate.01 tag that Wix placed, and also disconnects the site from its Bing account. It doesn't remove the site from Bing Webmaster Tools. To keep the tag and only remove the connection, call Disconnect in the BWT Connection API instead.

To remove the verification:

1. Call Clear Verification. If the call fails with UNAVAILABLE (BWT_SITE_BUSY or META_TAGS_WRITE_CONFLICT), another operation was changing the site at the same time, so retry.
2. Call Get Site Readiness to confirm that blockingReason is NOT_CONNECTED.