API to.co
Nechajte svoj vlastný softvér, napríklad web, pokladničný systém alebo skript, čítať vašu firmu na to.co a udržiavať ju aktuálnu. Kľúče sú v tarifoch Pro a Grow.
- Základná adresa URL
https://api.to.co/v1/orgs/{host}- Overovanie
Authorization: Bearer toco_ak_…
Získanie kľúča API
Otvorte svoju firmu v my.to.co a vyberte Kľúče API, potom Vytvoriť kľúč. Pomenujte ho, vyberte jeho rozsahy a platnosť (najviac rok) a skopírujte ho: zobrazí sa len raz a uchováva sa z neho iba hash.
Kľúč posielajte v hlavičke Authorization pri každej požiadavke. Kľúč funguje len pre vlastnú firmu: na akúkoľvek inú adresu odpovie, že nebolo nájdené. API prijíma len kľúče, nikdy reláciu prehliadača.
Ukážkové volanie
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Rozsahy a tarify
Kľúč môže robiť len to, čo povoľujú jeho rozsahy, a len to, čo tarif firmy zahŕňa v okamihu každej požiadavky. Čítanie je v tarifoch Pro a Grow; zmeny sú v tarife Grow.
| Rozsah | Čo robí | Od tarifu |
|---|---|---|
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 |
Cesty
Každá cesta je pod základnou adresou URL, s adresou vašej firmy na to.co namiesto {host}, napríklad mybusiness.uk.to.co. Požiadavky a odpovede sú vo formáte JSON. Zmeny prechádzajú rovnakými kontrolami, históriou a opätovným zverejnením ako zmeny urobené v my.to.co a zaznamenávajú sa ako urobené kľúčom.
| Cesta | Čo robí | Rozsah |
|---|---|---|
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 |
Kredity a limity
- Každá požiadavka spotrebuje jeden kredit API z rovnakého mesačného limitu ako volania vášho vlastného asistenta AI na server MCP vašej firmy: 5,000 mesačne na firmu v tarife Pro a 50,000 v tarife Grow. Požiadavka, ktorá zlyhá, kredit vráti. Kredity sa obnovujú 1. dňa každého mesiaca (UTC) a neúčtujú sa žiadne poplatky za prekročenie. Odpovede obsahujú X-Credits-Limit, X-Credits-Remaining a X-Credits-Reset.
- Najviac 120 požiadaviek za minútu na kľúč.
- Najviac 60 zmien za minútu na firmu, počítané spolu so zmenami urobenými v my.to.co a cez MCP.
Chyby
Chyba sa vráti so stavom HTTP a JSON: error (správa), code (jeden z nižšie uvedených) a request_id. Odpoveď 429 obsahuje 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.
Webhooky
V tarife Grow vie to.co posielať podpísané udalosti aj na váš vlastný server, keď sa niečo zmení, napríklad príde nová správa alebo sa zmenia údaje firmy. Nastavíte ich v my.to.co v sekcii Webhooky.