to.co API
Laske oma tarkvaral, näiteks veebisaidil, kassasüsteemil või skriptil, lugeda teie ettevõtet to.co-s ja hoida seda ajakohasena. Võtmed on saadaval Pro- ja Grow-paketis.
- Põhi-URL
https://api.to.co/v1/orgs/{host}- Autentimine
Authorization: Bearer toco_ak_…
Hankige API-võti
Avage oma ettevõte my.to.co-s ja valige API-võtmed, seejärel Loo võti. Andke sellele nimi, valige õigused ja aegumisaeg (kõige rohkem aasta) ning kopeerige see: seda näidatakse ainult üks kord ja sellest säilitatakse ainult räsi.
Saatke võti igas päringus Authorization-päises. Võti töötab ainult oma ettevõtte jaoks: iga teine aadress vastab, et seda ei leitud. API võtab vastu ainult võtmeid, mitte kunagi brauseri seanssi.
Näidispäring
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Õigused ja paketid
Võti saab teha ainult seda, mida selle õigused lubavad, ja ainult seda, mida ettevõtte pakett iga päringu hetkel sisaldab. Lugemine on saadaval Pro- ja Grow-paketis; muudatused Grow-paketis.
| Õigus | Mida see teeb | Alates paketist |
|---|---|---|
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 |
Marsruudid
Kõik marsruudid on põhi-URL-i all, kus {host} asemel on teie ettevõtte to.co aadress, näiteks mybusiness.uk.to.co. Päringud ja vastused on JSON-vormingus. Muudatused läbivad samad kontrollid, ajaloo ja uuesti avaldamise nagu my.to.co-s tehtud muudatused ning salvestatakse võtme tehtuna.
| Marsruut | Mida see teeb | Õigus |
|---|---|---|
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 |
Krediidid ja piirangud
- Iga päring kasutab ühe API-krediidi samast kuisest mahust, millest kulutavad ka teie enda AI-assistendi päringud teie ettevõtte MCP serverisse: Pro-paketis 5,000 kuus ettevõtte kohta ja Grow-paketis 50,000. Ebaõnnestunud päring annab krediidi tagasi. Krediidid algavad uuesti iga kuu 1. päeval (UTC) ja ületamise eest tasu ei võeta. Vastustes on päised X-Credits-Limit, X-Credits-Remaining ja X-Credits-Reset.
- Kuni 120 päringut minutis võtme kohta.
- Kuni 60 muudatust minutis ettevõtte kohta, arvestades ka my.to.co-s ja MCP kaudu tehtud muudatusi.
Vead
Viga vastab HTTP-oleku ja JSON-iga: error (teade), code (üks allpool toodutest) ja request_id. Vastus 429 sisaldab päist 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.
Webhookid
Grow-paketis saab to.co saata teie enda serverisse ka allkirjastatud sündmusi, kui midagi muutub, näiteks saabub uus sõnum või muutuvad teie ettevõtte andmed. Seadistage need my.to.co-s jaotises Webhookid.