API-et til to.co
La din egen programvare, for eksempel et nettsted, et kassesystem eller et skript, lese selskapet ditt på to.co og holde det oppdatert. Nøkler finnes i Pro og Grow.
- Basis-URL
https://api.to.co/v1/orgs/{host}- Autentisering
Authorization: Bearer toco_ak_…
Skaff en API-nøkkel
Åpne selskapet ditt i my.to.co og velg «API-nøkler» og deretter «Opprett nøkkel». Gi den et navn, velg tilganger og når den utløper (høyst om ett år), og kopier den: den vises bare én gang, og vi lagrer bare en hash av den.
Send nøkkelen i Authorization-headeren i hver forespørsel. En nøkkel virker bare for sitt eget selskap: alle andre adresser svarer «ikke funnet». API-et tar bare imot nøkler, aldri en nettleserøkt.
Eksempel på kall
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Tilganger og abonnementer
En nøkkel kan bare gjøre det tilgangene tillater, og bare det selskapets abonnement inkluderer i det øyeblikket hver forespørsel gjøres. Lesing finnes i Pro og Grow. Endringer finnes i Grow.
| Tilgang | Hva den gjør | Fra abonnement |
|---|---|---|
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 |
Ruter
Alle ruter ligger under basis-URL-en, med selskapets to.co-adresse i stedet for {host}, for eksempel mybusiness.uk.to.co. Forespørsler og svar er JSON. Endringer går gjennom de samme kontrollene, den samme historikken og den samme nypubliseringen som endringer gjort i my.to.co, og registreres som gjort av nøkkelen.
| Rute | Hva den gjør | Tilgang |
|---|---|---|
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 |
Kreditter og grenser
- Hver forespørsel bruker én API-kreditt, fra den samme månedlige kvoten som kallene din egen AI-assistent gjør til bedriftens MCP-server: 5,000 i måneden per selskap i Pro og 50,000 i Grow. En forespørsel som mislykkes, gir kreditten tilbake. Kredittene starter på nytt den 1. i hver måned (UTC), og det er ingen ekstra kostnader ved overforbruk. Svarene inneholder X-Credits-Limit, X-Credits-Remaining og X-Credits-Reset.
- Opptil 120 forespørsler i minuttet per nøkkel.
- Opptil 60 endringer i minuttet per selskap, regnet sammen med endringer gjort i my.to.co og over MCP.
Feil
En feil svarer med en HTTP-status og JSON: error (en melding), code (en av kodene nedenfor) og request_id. En 429 inneholder 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.
Webhooks
Med Grow kan to.co også sende signerte hendelser til din egen server når noe endres, for eksempel en ny melding eller en endring i selskapsopplysningene. Sett dem opp i my.to.co under «Webhooks».