to.co sākumlapa
Sākt

to.co API

Ļaujiet savai programmatūrai, piemēram, tīmekļa vietnei, kases sistēmai vai skriptam, nolasīt jūsu uzņēmumu vietnē to.co un uzturēt to aktuālu. Atslēgas ir pieejamas plānos Pro un Grow.

API atslēgas iegūšana Maršruti

Bāzes URL
https://api.to.co/v1/orgs/{host}
Autentifikācija
Authorization: Bearer toco_ak_…

API atslēgas iegūšana

Atveriet savu uzņēmumu vietnē my.to.co un izvēlieties „API atslēgas“, pēc tam „Izveidot atslēgu“. Piešķiriet tai nosaukumu, izvēlieties tās tvērumus un derīguma termiņu (ne ilgāk kā gads) un nokopējiet to: tā tiek parādīta vienreiz, un tiek glabāta tikai tās jaucējvērtība.

Sūtiet atslēgu galvenē Authorization katrā pieprasījumā. Atslēga darbojas tikai savam uzņēmumam: jebkura cita adrese atbild ar „nav atrasts“. API pieņem tikai atslēgas, nekad pārlūkprogrammas sesiju.

Izsaukuma piemērs

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

Tvērumi un plāni

Atslēga var darīt tikai to, ko atļauj tās tvērumi, un tikai to, ko uzņēmuma plāns ietver katra pieprasījuma brīdī. Lasīšana ir pieejama plānos Pro un Grow; izmaiņas — plānā Grow.

TvērumsKo tas daraSākot ar plānu
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

Maršruti

Visi maršruti atrodas zem bāzes URL, ar jūsu uzņēmuma to.co adresi {host} vietā, piemēram, mybusiness.uk.to.co. Pieprasījumi un atbildes ir JSON formātā. Izmaiņām tiek piemērotas tās pašas pārbaudes, vēsture un atkārtota publicēšana kā izmaiņām, kas veiktas vietnē my.to.co, un tās tiek reģistrētas kā atslēgas veiktas.

MaršrutsKo tas daraTvērums
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

Kredīti un ierobežojumi

  • Katrs pieprasījums izmanto vienu API kredītu no tā paša mēneša limita, ko izmanto jūsu AI asistenta izsaukumi uz jūsu uzņēmuma MCP serveri: 5,000 mēnesī katram uzņēmumam plānā Pro un 50,000 plānā Grow. Neizdevies pieprasījums kredītu atdod atpakaļ. Kredīti sākas no jauna katra mēneša 1. datumā (UTC), un maksas par pārsniegumu nav. Atbildēs ir galvenes X-Credits-Limit, X-Credits-Remaining un X-Credits-Reset.
  • Līdz 120 pieprasījumiem minūtē katrai atslēgai.
  • Līdz 60 izmaiņām minūtē katram uzņēmumam, ieskaitot izmaiņas, kas veiktas vietnē my.to.co un caur MCP.

Kļūdas

Kļūdas gadījumā atbilde satur HTTP statusu un JSON: error (ziņojums), code (viens no tālāk norādītajiem) un request_id. Atbildē 429 ir galvene 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

Plānā Grow to.co var arī sūtīt parakstītus notikumus uz jūsu serveri, kad kaut kas mainās, piemēram, pienāk jauna ziņa vai mainās jūsu uzņēmuma informācija. Iestatiet tos vietnē my.to.co sadaļā „Webhook“.

Tālākās darbības

Valoda

Izvēlieties kādu no valodām, ko vietne un lietotne pilnībā atbalsta.