API to.co
Biarkan software Anda sendiri, seperti situs web, sistem kasir, atau skrip, membaca data perusahaan Anda di to.co dan menjaganya tetap mutakhir. Kunci tersedia di paket Pro dan Grow.
- URL dasar
https://api.to.co/v1/orgs/{host}- Autentikasi
Authorization: Bearer toco_ak_…
Dapatkan kunci API
Buka perusahaan Anda di my.to.co dan pilih Kunci API, lalu Buat kunci. Beri nama, pilih cakupannya dan kapan kedaluwarsanya (paling lama satu tahun), lalu salin: kunci hanya ditampilkan sekali dan hanya hash-nya yang disimpan.
Kirim kunci di header Authorization pada setiap permintaan. Kunci hanya berlaku untuk perusahaannya sendiri: alamat lain akan dijawab tidak ditemukan. API hanya menerima kunci, tidak pernah sesi browser.
Contoh panggilan
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"
Cakupan dan paket
Kunci hanya dapat melakukan apa yang diizinkan cakupannya, dan hanya apa yang termasuk dalam paket perusahaan pada saat setiap permintaan. Membaca tersedia di paket Pro dan Grow; perubahan tersedia di paket Grow.
| Cakupan | Fungsinya | Mulai paket |
|---|---|---|
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 |
Rute
Setiap rute berada di bawah URL dasar, dengan alamat to.co perusahaan Anda di tempat {host}, misalnya mybusiness.uk.to.co. Permintaan dan jawaban berformat JSON. Perubahan melewati pemeriksaan, riwayat, dan penerbitan ulang yang sama seperti perubahan yang dibuat di my.to.co, dicatat sebagai dibuat oleh kunci tersebut.
| Rute | Fungsinya | Cakupan |
|---|---|---|
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 |
Kredit dan batas
- Setiap permintaan menggunakan satu kredit API, dari kuota bulanan yang sama dengan panggilan asisten AI Anda sendiri ke server MCP bisnis Anda: 5,000 per bulan per perusahaan di paket Pro dan 50,000 di paket Grow. Permintaan yang gagal mengembalikan kreditnya. Kredit dimulai lagi setiap tanggal 1 (UTC), dan tidak ada biaya kelebihan pemakaian. Jawaban membawa X-Credits-Limit, X-Credits-Remaining, dan X-Credits-Reset.
- Hingga 120 permintaan per menit per kunci.
- Hingga 60 perubahan per menit per perusahaan, dihitung bersama perubahan yang dibuat di my.to.co dan melalui MCP.
Galat
Galat dijawab dengan status HTTP dan JSON: error (pesan), code (salah satu dari di bawah ini), dan request_id. Status 429 membawa 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.
Webhook
Di paket Grow, to.co juga dapat mengirim peristiwa bertanda tangan ke server Anda sendiri saat sesuatu berubah, seperti pesan baru atau perubahan detail perusahaan Anda. Siapkan di my.to.co pada bagian Webhook.