Tài liệu tham khảo API
seo-connect
Có 81 điểm cuối trong khu vực này. Mỗi điểm cuối có một trang riêng với các tham số, phản hồi và yêu cầu mà quý vị có thể thực hiện.
| Phương thức | Đường dẫn | Chức năng | Quyền |
|---|---|---|---|
| POST | /v1/plugin-ai/complete | Run the Zinn® SEO plugin's AI on Zinn® credits. Spends credits. | billing.view |
| POST | /v1/seo-connect/approve | Approve a site connection for one organization. | Bất kỳ khóa API nào |
| POST | /v1/seo-connect/deny | Refuse a site connection request. | Bất kỳ khóa API nào |
| GET | /v1/seo-connect/requests/{userCode} | Read a pending site connection request (the approval page). | Bất kỳ khóa API nào |
| POST | /v1/seo-connect/signup | Create a Zinn® account from inside the plugin, and start connecting the site. | Không có khóa API |
| POST | /v1/seo-connect/start | Start connecting a Zinn® SEO site to a Zinn® account (device code). | Không có khóa API |
| POST | /v1/seo-connect/token | Exchange an approved device code for the site's connection token. | Không có khóa API |
| DELETE | /v1/seo-connection | Disconnect this site (revoke from the site side). | Token riêng của nó |
| GET | /v1/seo-connection | Read this site's own Zinn® SEO connection. | Token riêng của nó |
| GET | /v1/seo-connection/account | The site's credit position — balance, 30-day forecast, holds, prices. | Token riêng của nó |
| GET | /v1/seo-connection/catalogue | Every live SEO product V2 sells, its price, and what this site's account holds. | sites.view |
| DELETE | /v1/seo-connection/cdn | Switch the Zinn® CDN off for this site. | sites.create |
| GET | /v1/seo-connection/cdn | The Zinn® CDN for this site — offered here or not, its zone, this month, its price. | sites.view |
| POST | /v1/seo-connection/cdn | Switch the Zinn® CDN on for this site, in one click. Idempotent. | sites.create |
| POST | /v1/seo-connection/cdn/purge | Drop everything the site's Zinn® CDN has cached. Free. | sites.create |
| POST | /v1/seo-connection/cloak-checks | Fetch a page as a visitor and as Googlebot, and compare. Free. | sites.create |
| GET | /v1/seo-connection/crux | Real-visitor Core Web Vitals (Chrome UX Report) for the site. Free. | sites.view |
| GET | /v1/seo-connection/edge | Whether the site is on Zinn® hosting, and what the engine does at its edge. | sites.view |
| POST | /v1/seo-connection/edge | Purge the site's pages at the edge and set its AI-crawler rule. Free. | sites.create |
| DELETE | /v1/seo-connection/google | Disconnect the site's Google account. | Token riêng của nó |
| GET | /v1/seo-connection/google | Whether the site's own Google account is connected, and what it reads. Free. | Token riêng của nó |
| PATCH | /v1/seo-connection/google | Choose the Search Console property, GA4 property and Business Profile location. | Token riêng của nó |
| POST | /v1/seo-connection/google | Start "Connect Google" — Google's consent page for this site. | Token riêng của nó |
| POST | /v1/seo-connection/google/analytics | GA4 landing-page sessions, key events and revenue for the chosen property. Free. | Token riêng của nó |
| POST | /v1/seo-connection/google/business/posts | Publish a post on the chosen Business Profile location. | Token riêng của nó |
| GET | /v1/seo-connection/google/business/reviews | Google reviews of the chosen Business Profile location, newest first. | Token riêng của nó |
| POST | /v1/seo-connection/google/business/reviews/{reviewId}/reply | Reply to (or change the reply to) one Google review. | Token riêng của nó |
| GET | /v1/seo-connection/google/callback | Google's return after consent (a browser redirect). | Không có khóa API |
| POST | /v1/seo-connection/google/indexing | Tell Google's Indexing API a job posting or livestream page changed or went. | Token riêng của nó |
| POST | /v1/seo-connection/google/search-analytics | Search Console clicks, impressions, CTR and position for the chosen property. Free. | Token riêng của nó |
| GET | /v1/seo-connection/google/sitemaps | The sitemaps Search Console knows for the chosen property, with errors and counts. | Token riêng của nó |
| POST | /v1/seo-connection/google/sitemaps | Submit one of this site's sitemaps to Search Console. | Token riêng của nó |
| POST | /v1/seo-connection/google/url-inspection | Google's own index verdict for one page of this site (URL Inspection). Free. | Token riêng của nó |
| GET | /v1/seo-connection/guard | SEO Guard for this site — settings, open problems and recent fixes. | sites.view |
| PUT | /v1/seo-connection/guard | Change SEO Guard for this site. | sites.create |
| POST | /v1/seo-connection/images | Draw one image from a description on Zinn® credits. Spends credits. | sites.create |
| GET | /v1/seo-connection/images/{runId} | One image run; when complete, the picture itself. | sites.view |
| POST | /v1/seo-connection/index-checks | Check whether pages of the site are in Google's index. Spends credits. | sites.create |
| GET | /v1/seo-connection/index-checks/{runId} | One batch of index checks, with every page's answer. | sites.view |
| POST | /v1/seo-connection/lab-tests | Lighthouse lab test of one page on our own runner. Free on Zinn Digital® hosting. | sites.create |
| GET | /v1/seo-connection/notices | The connected site's notices feed — credits, alerts and SEO Guard. | billing.view |
| POST | /v1/seo-connection/notices | Dismiss notices for this site. | billing.view |
| GET | /v1/seo-connection/offers | What Zinn® sells inside the plugin, each product priced from its live row. | sites.view |
| POST | /v1/seo-connection/offers/domains/search | Is a domain free, and what does it cost to register for a year? | sites.view |
| GET | /v1/seo-connection/offers/orders | The orders this site placed, with where each one is now. | sites.view |
| POST | /v1/seo-connection/offers/orders | Open the basket an offer's order needs. Charges nothing. | sites.create |
| POST | /v1/seo-connection/offers/orders/{orderId}/placement | Where a bought link went live; watched by link watch from now on. | sites.create |
| GET | /v1/seo-connection/offers/{offer}/{product}/listings | The live marketplace listings a link, article, citation or expert offer sells. | sites.view |
| POST | /v1/seo-connection/originality | Search the web for a draft's sentences word for word. Spends credits. | sites.create |
| GET | /v1/seo-connection/originality/quote | What an originality check of this many sentences would cost. Free. | sites.view |
| GET | /v1/seo-connection/originality/{runId} | One originality check, and where each sentence was found. | sites.view |
| GET | /v1/seo-connection/products | The site's credit tools and what one unit of each costs. | sites.view |
| POST | /v1/seo-connection/products/places | Find a business on Google Maps, to pick "this is my business". Free to the site. | sites.view |
| GET | /v1/seo-connection/products/runs | This site's recent credit-tool runs, newest first. | sites.view |
| GET | /v1/seo-connection/products/runs/{runId} | One credit-tool run, with its answer, its alerts and what it cost. | sites.view |
| GET | /v1/seo-connection/products/runs/{runId}/screenshot | The picture of a results page a snapshot run took (PNG). | sites.view |
| GET | /v1/seo-connection/products/watches | The credit tools this site runs on a schedule, with each one's cost. | sites.view |
| POST | /v1/seo-connection/products/watches | Put a credit tool on a schedule. Spends credits on each run. | sites.create |
| DELETE | /v1/seo-connection/products/watches/{watchId} | Take a credit tool off the schedule. Its past runs are kept. | sites.create |
| PATCH | /v1/seo-connection/products/watches/{watchId} | Change, pause or restart a scheduled credit tool. | sites.create |
| POST | /v1/seo-connection/products/{product}/quote | What one run would cost, before it is asked for. Spends nothing. | sites.view |
| POST | /v1/seo-connection/products/{product}/runs | Run one credit tool now. Spends credits. | sites.create |
| GET | /v1/seo-connection/reports | This site's white-label client report: client, look, schedule, reports, deliveries and client pages. | sites.view |
| PUT | /v1/seo-connection/reports | Set up or change this site's client and its report schedule. | sites.create |
| PUT | /v1/seo-connection/reports/brand | The agency's look on this site's report and e-mail, and the client's own logo. | sites.create |
| POST | /v1/seo-connection/reports/portal-links | A read-only page for the client, no login (zs-421). | sites.create |
| DELETE | /v1/seo-connection/reports/portal-links/{link_id} | Turn a client page off now. | sites.create |
| POST | /v1/seo-connection/reports/run | Make this site's report now. | sites.create |
| POST | /v1/seo-connection/reports/sinks | Deliver this site's reports into a Google Sheet or Drive folder. | sites.create |
| DELETE | /v1/seo-connection/reports/sinks/{sink_id} | Stop delivering into that Sheet or folder and forget the grant. | sites.create |
| POST | /v1/seo-connection/reports/sinks/{sink_id}/sync | Deliver the latest report into that Sheet or folder now. | sites.create |
| GET | /v1/seo-connection/reports/{report_id} | One of this site's reports (poll until ready). | sites.view |
| POST | /v1/seo-connection/research/{tool} | Run one research report on the site. Spends credits when the plan lacks it. | sites.create |
| GET | /v1/seo-connection/site-checks/{checkId} | One cloak check or lab test, with its result. | sites.view |
| GET | /v1/seo-connection/target | The connected site's own watch-list row, created on first use. | sites.view |
| POST | /v1/seo-connection/work-log | The plugin reports what it did on the site, for the client's report. | sites.create |
| GET | /v1/seo-connections | The organization's connected Zinn® SEO sites. | Bất kỳ khóa API nào |
| DELETE | /v1/seo-connections/{connectionId} | Disconnect a site from the app. | Bất kỳ khóa API nào |
| PATCH | /v1/seo-connections/{connectionId} | Change what a connected site may do, and its monthly credit limit. | Bất kỳ khóa API nào |
| GET | /v1/seo/agency-overview | Every connected Zinn® SEO site of the organization, with scores, alerts and spend. | billing.view |
| GET | /v1/zinn-cdn/zones | Every Zinn® CDN of the organization, with this month's traffic and cost. | billing.view |