Pagina principală to.co

API-ul to.co

Lăsați propriul software, cum ar fi un site, un sistem de casă sau un script, să citească firma dvs. de pe to.co și să o țină la zi. Cheile sunt disponibile pe Pro și Grow.

Obțineți o cheie API Rute

URL de bază
https://api.to.co/v1/orgs/{host}
Autentificare
Authorization: Bearer toco_ak_…

Obțineți o cheie API

Deschideți firma în my.to.co și alegeți Chei API, apoi Creați cheie. Dați-i un nume, alegeți domeniile ei de acces (scopes) și când expiră (cel mult un an) și copiați-o: este afișată o singură dată și se păstrează doar un hash al ei.

Trimiteți cheia în antetul Authorization la fiecare cerere. O cheie funcționează doar pentru propria firmă: orice altă adresă răspunde „negăsit”. API-ul acceptă doar chei, niciodată o sesiune de browser.

Exemplu de apel

curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
  -H "Authorization: Bearer toco_ak_…"

Domenii de acces și planuri

O cheie poate face doar ce permit domeniile ei de acces și doar ce include planul firmei în momentul fiecărei cereri. Citirea este pe Pro și Grow; modificările sunt pe Grow.

Domeniu de accesCe faceDe la planul
company:readYour company details, services and locations.Pro
messages:readMessages from your contact form (not those held as spam).Pro
company:writeReplace your services, and change phone numbers and opening hours.Grow
posts:readThe posts you write on to.co, drafts included.Pro
posts:writeWrite, save, publish, unpublish and delete posts.Grow

Rute

Fiecare rută se află sub URL-ul de bază, cu adresa to.co a firmei dvs. în locul lui {host}, de exemplu mybusiness.uk.to.co. Cererile și răspunsurile sunt JSON. Modificările trec prin aceleași controale, același istoric și aceeași republicare ca cele făcute în my.to.co, consemnate ca făcute de cheie.

RutăCe faceDomeniu de acces
GET /v1/orgs/{host}The company record, with its services and locations.company:read
GET /v1/orgs/{host}/servicesThe services, in order.company:read
GET /v1/orgs/{host}/locationsThe locations, with phones and opening hours.company:read
GET /v1/orgs/{host}/messagesContact form messages. Filter with ?status=new|read|replied|archived.messages:read
GET /v1/orgs/{host}/messages/{id}One message.messages:read
PATCH /v1/orgs/{host}Change the company phone numbers: JSON { "phones": … }.company:write
PUT /v1/orgs/{host}/servicesReplace the whole list of services, in order: JSON { "services": [ … ] }.company:write
PATCH /v1/orgs/{host}/locations/{location}Change a location: JSON with any of phones, normal_hours and special_hours. Every value is checked, and the answer carries the checks. The registered office comes from the register and cannot be changed.company:write
GET /v1/orgs/{host}/postsPosts written on to.co, newest change first, a page at a time: ?limit, ?state and ?cursor (next_cursor from the page before).posts:read
GET /v1/orgs/{host}/posts/{id}One post, its body as blocks, with its version as the ETag.posts:read
POST /v1/orgs/{host}/postsA new draft: JSON { "title", "standfirst", "body" }, or the body as text/markdown.posts:write
PATCH /v1/orgs/{host}/posts/{id}Save a post. Send the version you are changing as If-Match; JSON, or the body as text/markdown.posts:write
DELETE /v1/orgs/{host}/posts/{id}Move a post to the bin. The owner can restore it in my.to.co for 30 days.posts:write
POST /v1/orgs/{host}/posts/{id}/publishPublish the If-Match version. It is checked first, as when the owner publishes.posts:write
POST /v1/orgs/{host}/posts/{id}/unpublishTake a post off the page and back to a draft.posts:write

Credite și limite

  • Fiecare cerere folosește un credit API, din aceeași alocare lunară ca apelurile propriului asistent AI către serverul MCP al firmei: 5,000 pe lună pe firmă la Pro și 50,000 la Grow. O cerere care eșuează își returnează creditul. Creditele se reiau pe 1 ale fiecărei luni (UTC) și nu există taxe pentru depășire. Răspunsurile conțin X-Credits-Limit, X-Credits-Remaining și X-Credits-Reset.
  • Până la 120 cereri pe minut pe cheie.
  • Până la 60 modificări pe minut pe firmă, numărate împreună cu modificările făcute în my.to.co și prin MCP.

Erori

O eroare răspunde cu o stare HTTP și JSON: error (un mesaj), code (unul dintre cele de mai jos) și request_id. Un 429 conține Retry-After.

  • invalid_request (400) — The body or a query value is not valid; the message says which field.
  • cookie_not_accepted (400) — The request carried a browser session. This API takes an API key only.
  • if_match_required (400) — A post change without If-Match.
  • not_ready (400) — The post cannot be published yet; problems lists why.
  • image_unknown (400) — A post body shows an image the post does not have. A key cannot upload images.
  • invalid_key (401) — No key, or one that is unknown, revoked or expired.
  • insufficient_scope (403) — The key does not have the scope this route needs.
  • plan_required (403) — The company plan does not include this scope now; plan_needed names the plan that does.
  • insufficient_role (403) — The person who made the key no longer has the role for this; an owner makes a new key.
  • not_found (404) — Not found. A host other than the key's own company is always not found.
  • registered_office (409) — The registered office comes from the company register and cannot be changed with a key.
  • post_changed (409) — The post changed since the If-Match version. Read it again.
  • post_deleted (409) — The post is in the bin.
  • not_draft (409) — Only a draft can be scheduled.
  • slug_taken (409) — Another post already uses that address.
  • rate_limited (429) — Too many requests. Wait for Retry-After.
  • credits_exhausted (429) — This month's API credits are used. They start again on the first of next month; there are no overage charges.
  • credits_unavailable (503) — The API cannot count credits right now. Try again later.

Webhookuri

Pe Grow, to.co poate trimite și evenimente semnate către propriul server când se schimbă ceva, cum ar fi un mesaj nou sau o modificare a datelor firmei. Configurați-le în my.to.co, la Webhookuri.

Pașii următori

Limba