A to.co API
Engedje, hogy saját szoftvere, például egy weboldal, egy pénztárrendszer vagy egy szkript, olvassa a to.co-n lévő cégét, és naprakészen tartsa. A kulcsok a Pro és a Grow csomagon érhetők el.
- Alap-URL
https://api.to.co/v1/orgs/{host}- Hitelesítés
Authorization: Bearer toco_ak_…
API-kulcs kérése
Nyissa meg a cégét a my.to.co-ban, válassza az API-kulcsok, majd a Kulcs létrehozása lehetőséget. Nevezze el, válassza ki a hatóköreit és a lejáratát (legfeljebb egy év), és másolja ki: egyszer jelenik meg, és csak a hash-ét őrizzük meg.
Küldje el a kulcsot az Authorization fejlécben minden kérésnél. A kulcs csak a saját cégénél működik: bármely más cím „nem található” választ ad. Az API csak kulcsokat fogad, böngészőmunkamenetet soha.
Példahívás
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Hatókörök és csomagok
A kulcs csak azt teheti, amit a hatókörei engedélyeznek, és csak azt, amit a cég csomagja az egyes kérések pillanatában tartalmaz. Az olvasás a Pro és a Grow csomagon érhető el; a módosítások a Grow csomagon.
| Hatókör | Mit csinál | Ettől a csomagtól |
|---|---|---|
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 |
Útvonalak
Minden útvonal az alap-URL alatt van, a {host} helyén a cége to.co-címével, például mybusiness.uk.to.co. A kérések és válaszok JSON formátumúak. A módosítások ugyanazokon az ellenőrzéseken, előzményeken és újra közzétételen mennek át, mint a my.to.co-ban végzett módosítások, a kulcs általi módosításként rögzítve.
| Útvonal | Mit csinál | Hatókör |
|---|---|---|
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 |
Kreditek és korlátok
- Minden kérés egy API-kreditet használ el, ugyanabból a havi keretből, mint a saját AI-asszisztense hívásai a vállalkozása MCP-kiszolgálóján: cégenként havonta 5,000 a Pro és 50,000 a Grow csomagon. A sikertelen kérés visszaadja a kreditjét. A kreditek minden hónap 1-jén (UTC) újraindulnak, és nincs többletdíj. A válaszok tartalmazzák az X-Credits-Limit, X-Credits-Remaining és X-Credits-Reset fejléceket.
- Kulcsonként percenként legfeljebb 120 kérés.
- Cégenként percenként legfeljebb 60 módosítás, a my.to.co-ban és az MCP-n keresztül végzett módosításokkal együtt számolva.
Hibák
A hiba HTTP-állapottal és JSON-nal válaszol: error (üzenet), code (az alábbiak egyike) és request_id. A 429 tartalmaz Retry-After fejlécet.
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.
Webhookok
A Grow csomagon a to.co aláírt eseményeket is küldhet a saját kiszolgálójának, ha valami változik, például új üzenet érkezik vagy változnak a cége adatai. Állítsa be őket a my.to.co-ban a Webhookok alatt.