Начална страница на to.co
Започнете

API на to.co

Позволете на собствения си софтуер, например уебсайт, касова система или скрипт, да чете фирмата ви в to.co и да я поддържа актуална. Ключовете са в Pro и Grow.

Вземете API ключ Маршрути

Базов адрес
https://api.to.co/v1/orgs/{host}
Удостоверяване
Authorization: Bearer toco_ak_…

Вземете API ключ

Отворете фирмата си в my.to.co и изберете „API ключове“, после „Създаване на ключ“. Наименувайте го, изберете обхватите му и кога изтича (най-много след година) и го копирайте: показва се веднъж и се пази само хеш от него.

Изпращайте ключа в заглавката Authorization при всяка заявка. Ключът работи само за своята фирма: всеки друг адрес отговаря „не е намерено“. API приема само ключове, никога сесия от браузър.

Пример за извикване

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

Обхвати и планове

Ключът може да прави само онова, което обхватите му позволяват, и само онова, което планът на фирмата включва в момента на всяка заявка. Четенето е в Pro и Grow; промените са в Grow.

ОбхватКакво правиОт план
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

Маршрути

Всеки маршрут е под базовия адрес, с адреса на фирмата ви в to.co на мястото на {host}, например mybusiness.uk.to.co. Заявките и отговорите са JSON. Промените минават през същите проверки, история и повторно публикуване като промените в my.to.co и се записват като направени от ключа.

МаршрутКакво правиОбхват
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

Кредити и ограничения

  • Всяка заявка използва един API кредит от същия месечен лимит като обажданията на собствения ви AI асистент към MCP сървъра на фирмата ви: 5,000 на месец за фирма в Pro и 50,000 в Grow. Неуспешна заявка връща кредита си. Кредитите започват отново на 1-во число всеки месец (UTC) и няма такси за превишаване. Отговорите носят X-Credits-Limit, X-Credits-Remaining и X-Credits-Reset.
  • До 120 заявки в минута на ключ.
  • До 60 промени в минута на фирма, броени заедно с промените в my.to.co и през MCP.

Грешки

Грешката се отговаря с HTTP статус и JSON: error (съобщение), code (един от изброените по-долу) и request_id. 429 носи 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.

Webhook

В Grow to.co може да изпраща и подписани събития до собствения ви сървър, когато нещо се промени, например ново съобщение или промяна в данните на фирмата ви. Настройте ги в my.to.co, в „Webhook“.

Следващи стъпки

Език