to.co API'si
Web sitesi, kasa sistemi veya bir betik gibi kendi yazılımınızın to.co'daki şirketinizi okumasına ve güncel tutmasına izin verin. Anahtarlar Pro ve Grow planlarında bulunur.
- Temel URL
https://api.to.co/v1/orgs/{host}- Kimlik doğrulama
Authorization: Bearer toco_ak_…
API anahtarı alın
Şirketinizi my.to.co'da açın, API anahtarları'nı ve ardından Anahtar oluştur'u seçin. Anahtara bir ad verin, kapsamlarını ve ne zaman sona ereceğini (en fazla bir yıl) seçin ve kopyalayın: anahtar yalnızca bir kez gösterilir ve yalnızca karma değeri saklanır.
Anahtarı her istekte Authorization başlığında gönderin. Bir anahtar yalnızca kendi şirketi için çalışır: başka herhangi bir adres bulunamadı yanıtı verir. API yalnızca anahtar kabul eder, asla tarayıcı oturumu kabul etmez.
Örnek çağrı
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Kapsamlar ve planlar
Bir anahtar yalnızca kapsamlarının izin verdiğini ve yalnızca her istek anında şirketin planının içerdiğini yapabilir. Okuma Pro ve Grow planlarında, değişiklikler Grow planında bulunur.
| Kapsam | Ne yapar | Başlangıç planı |
|---|---|---|
company:read | Your company details, services and locations. | Pro |
messages:read | Messages from your contact form (not those held as spam). | Pro |
company:write | Replace your services, and change phone numbers and opening hours. | Grow |
posts:read | The posts you write on to.co, drafts included. | Pro |
posts:write | Write, save, publish, unpublish and delete posts. | Grow |
Uç noktalar
Her uç nokta, {host} yerine şirketinizin to.co adresi (örneğin mybusiness.uk.to.co) gelecek şekilde temel URL'nin altındadır. İstekler ve yanıtlar JSON biçimindedir. Değişiklikler, my.to.co'da yapılan değişikliklerle aynı kontrollerden, geçmiş kaydından ve yeniden yayımlamadan geçer ve anahtar tarafından yapılmış olarak kaydedilir.
| Uç nokta | Ne yapar | Kapsam |
|---|---|---|
GET /v1/orgs/{host} | The company record, with its services and locations. | company:read |
GET /v1/orgs/{host}/services | The services, in order. | company:read |
GET /v1/orgs/{host}/locations | The locations, with phones and opening hours. | company:read |
GET /v1/orgs/{host}/messages | Contact 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}/services | Replace 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}/posts | Posts 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}/posts | A 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}/publish | Publish the If-Match version. It is checked first, as when the owner publishes. | posts:write |
POST /v1/orgs/{host}/posts/{id}/unpublish | Take a post off the page and back to a draft. | posts:write |
Krediler ve sınırlar
- Her istek, kendi AI asistanınızın işletmenizin MCP sunucusuna yaptığı çağrılarla aynı aylık haktan bir API kredisi kullanır: şirket başına ayda Pro planında 5,000, Grow planında 50,000. Başarısız olan bir istek kredisini geri verir. Krediler her ayın 1'inde (UTC) yeniden başlar ve aşım ücreti alınmaz. Yanıtlar X-Credits-Limit, X-Credits-Remaining ve X-Credits-Reset başlıklarını içerir.
- Anahtar başına dakikada en fazla 120 istek.
- Şirket başına dakikada en fazla 60 değişiklik; my.to.co'da ve MCP üzerinden yapılan değişikliklerle birlikte sayılır.
Hatalar
Bir hata, bir HTTP durumu ve JSON ile yanıt verir: error (bir mesaj), code (aşağıdakilerden biri) ve request_id. 429 yanıtı Retry-After içerir.
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'lar
Grow planında to.co, yeni bir mesaj veya şirket bilgilerinizde bir değişiklik gibi bir şey değiştiğinde kendi sunucunuza imzalı olaylar da gönderebilir. Bunları my.to.co'da Webhook'lar bölümünden kurun.