API to.co
Umožněte svému vlastnímu softwaru, například webu, pokladnímu systému nebo skriptu, číst vaši společnost na to.co a udržovat ji aktuální. Klíče jsou k dispozici v tarifech Pro a Grow.
- Základní URL
https://api.to.co/v1/orgs/{host}- Ověřování
Authorization: Bearer toco_ak_…
Získání klíče API
Otevřete svou společnost v my.to.co, zvolte Klíče API a pak Vytvořit klíč. Pojmenujte ho, zvolte jeho rozsahy a datum vypršení (nejvýše za rok) a zkopírujte ho: zobrazí se jen jednou a uchovává se jen jeho hash.
Klíč posílejte v hlavičce Authorization u každého požadavku. Klíč funguje jen pro svou vlastní společnost: jakákoli jiná adresa odpoví, že nebyla nalezena. API přijímá jen klíče, nikdy relaci prohlížeče.
Příklad volání
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Rozsahy a tarify
Klíč může dělat jen to, co povolují jeho rozsahy, a jen to, co tarif společnosti zahrnuje v okamžiku každého požadavku. Čtení je v tarifech Pro a Grow; změny v tarifu Grow.
| Rozsah | Co dělá | 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
Všechny cesty jsou pod základní URL, s adresou vaší společnosti na to.co místo {host}, například mojefirma.uk.to.co. Požadavky i odpovědi jsou ve formátu JSON. Změny procházejí stejnými kontrolami, historií a opětovným zveřejněním jako změny provedené v my.to.co a zaznamenávají se jako provedené klíčem.
| Cesta | Co dělá | 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žadavek spotřebuje jeden kredit API ze stejného měsíčního limitu jako volání vašeho vlastního asistenta AI na server MCP vaší firmy: 5,000 měsíčně na společnost v tarifu Pro a 50,000 v tarifu Grow. Neúspěšný požadavek svůj kredit vrátí. Kredity se obnovují 1. dne každého měsíce (UTC) a za překročení se nic neúčtuje. Odpovědi obsahují X-Credits-Limit, X-Credits-Remaining a X-Credits-Reset.
- Limit požadavků na klíč: 120 za minutu.
- Limit změn na společnost: 60 za minutu, včetně změn provedených v my.to.co a přes MCP.
Chyby
Chyba odpoví stavem HTTP a JSON: error (zpráva), code (jeden z kódů níže) a request_id. Odpověď 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 tarifu Grow může to.co také posílat podepsané události na váš vlastní server, když se něco změní, například přijde nová zpráva nebo se změní údaje vaší společnosti. Nastavíte je v my.to.co v části Webhooky.