Bangun di Eyivo melalui satu terstruktur API.

Persegi 1

The Eyivo REST API adalah pesawat kontrol programmatic untuk website terstruktur yang menggunakan HTTPS dan JSON, adalah versi di bawah /api/v1, dan berlaku kepemilikan yang sama, batas rencana, validasi, dan audit batas sebagai dasbor.

Versi: memecah perubahan kontrak memerlukan versi dasar baru. Ruas addititif mungkin muncul dalam ada JSON objek, sehingga klien harus mengabaikan bidang yang tidak mereka kenal.

2, cepat mulai.

1. 1
   Buat token.

   Masuk ke App, buka API token, pilih yang terkecil perlu scopes, dan salin ey_ rahasia ketika ditampilkan.

2. 2
   Daftar situs Anda.

   Konfirmasi otentikasi dan dapatkan ID situs numerik yang dipakai oleh nested titik akhir.

3. 3
   Kirim idempoten menulis.

   Berikan setiap POST, PATCH, dan DELETE meminta unik Idempotency-Key.

curl --request GET \
  --url https://app.eyivo.com/api/v1/sites \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ey_your_token'

A successful response wraps in data:

{
  "data": [
    {
      "id": 42,
      "platform_subdomain_key": "7kr9mp2x",
      "template_key": "corporate-01",
      "status": "active",
      "native_locale": "en",
      "english_enabled": false,
      "content_version": 1,
      "search_visibility": "platform_noindex"
    }
  ]
}

3. Otentikasi

Setiap /api/v1 permintaan membutuhkan tanda tangan:

Authorization: Bearer <token>

PKCE aliran otorisasi

1. Buat sebuah high-entropi code_verifier dan SHA-256 code_challenge.
2. Arahkan pengguna ke /oauth/authorize dengan response_type=code, masyarakat client_id, benar-benar terdaftar redirect_uri, diminta spasi-dipisahkan scope, state, code_challenge, dan code_challenge_method=S256.
3. Verifikasi state setelah redirect, kemudian pertukaran kode otorisasi kembali di /oauth/token menggunakan asli code_verifier.
4. Simpan akses dan token segarkan secara aman. Segarkan sebelum kadaluwarsa dan ganti kredensial yang diputar secara otomatis.

4.

Permintaan membutuhkan lingkup yang tepat di bawah ini. * melewati semua pemeriksaan lingkup; aplikasi seharusnya masih meminta set lingkup praktis terkecil.

REST memerlukan cakupan endpoint, bukan mcp:use. Endpoint media menggunakan media:read atau media:write.

5.

Kirim sebuah Idempotency- Kunci dengan JSON Mutasi sehingga permintaan yang sama dapat dicoba lagi dengan aman. Upload dan upload- mengeluarkan tiket; verifikasi hasil transfer sebelum mencoba kembali.

Idempotency-Key: site-42-page-create-01J7M6Y8RRF3ZE6WB4Z0Y9XJXC

Sebuah permintaan cocok termasuk HTTP metode, jalur permintaan, dan badan permintaan mentah tepat. Gunakan lagi serialisasi asli JSON ketika mencoba lagi.

6.

Operasi konten mengembalikan sebuah amplop data. MCP persediaan Konten strukturedden plus JSON cermin teks; REST kembali JSON. Baca setiap skema keluaran untuk ID, kesiapan publikasi dan paginasi. Blog, media dan submission paginate; ikuti informasi halaman mereka yang kembali.

{ "data": { "id": 42, "status": "active" } }

{ "data": [{ "id": 42 }, { "id": 43 }] }

Bentuk koleksi bervariasi. Ikuti metadata dokumentasi setiap titik akhir; jangan asumsikan setiap hasil adalah daftar datar atau tak berpaginasi.

7.

Buat situs

curl --request POST \
  --url https://app.eyivo.com/api/v1/sites \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ey_your_token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: site-create-01J7M6Y8' \
  --data '{
    "display_name": "Northstar Studio",
    "template_key": "corporate-01",
    "native_locale": "en"
  }'

Respon: 201 Created dengan sumber daya situs. Menyediakan dapat awalnya melaporkan status tidak aktif ketika penempatan komplit. Situs dan rencana membatasi kembali 422.

Kolom sumber daya tempat: id, platform_subdomain_key, template_key, status, native_locale, english_enabled, content_version, search_visibility, opsional runtime, dan penanda waktu.

Halaman 8

Buat halaman

{
  "type": "page",
  "sort_order": 300,
  "locale": "en",
  "slug": "our-story",
  "title": "Our story",
  "body": "<p>How the company began.</p>",
  "meta_title": "Our story | Northstar Studio",
  "meta_description": "Learn about Northstar Studio."
}

Buat respon: 201. Respon pemutakhiran: 200. Respon hapus: 204 tanpa tubuh.

Simpan draft, periksa kesiapan, kemudian terbitkan item dan bahasa ketika pengguna ingin perubahan hidup. Publishing tidak mempublikasikan draf yang tidak terkait.

Benda katalog

Buat suatu butir katalog

{
  "sort_order": 100,
  "locale": "en",
  "slug": "strategy-advisory",
  "title": "Strategy advisory",
  "summary": "Focused advice for consequential decisions.",
  "body": "Talk to our senior advisory team."
}

Simpan draft, periksa kesiapan, kemudian terbitkan item dan bahasa ketika pengguna ingin perubahan hidup. Publishing tidak mempublikasikan draf yang tidak terkait.

Ini adalah contoh dari keluarga konten. Temukan skema masukan / keluaran lengkap dan yang diperlukan melalui alat / daftar atau dokumen OpenAPI kanonikal. REST jalur di bawah ini relatif terhadap / api / v1 / situs / {site}.

Kemampuan dan menulis kontrak

Pilih sebuah situs, lalu baca kemampuannya: dialognya, bidang tema, skema komponen, lokasi menu dan panel plugin yang terpasang. Baca alur kerja kontra sebelum menulis. Klien tanpa sumber daya dapat menggunakan get-sitecabilicis- tool. Ikuti perkakas / list NextCursor sampai penemuan selesai.

GET /api/v1/sites/{site}/capabilities
GET /api/v1/sites/{site}/pages/{page_id}/components/schema?locale=en

Gunakan lokal yang diminta atau revisi. Blog menyimpan ganti dokumen lengkap dan batalkan jadwalnya. Menu edit memakai revisi integer; tugas isi memakai hash menu _ revisi terpisah. Pertahankan masukan dalam urutan pengganti. Pada konflik, baca lagi dan gabungkan edits yang dimaksudkan sebelum mencoba kembali.

Navigasi utama tetap otomatis. Tambahan menu memiliki draf dan publikasi mereka sendiri. Menyimpan tahap isi menu tugas; penerbitan bahwa item menerapkan mereka tanpa menerbitkan draf menu lain. Publishing menu tidak pernah mempublikasikan isinya terkait. Sebuah halaman source _ hash menolak terjemahan berdasarkan teks sumber usang.

Ruas halaman dan ruas richtext tema menerima disterilkan HTML. Gunakan list- page-links- tool untuk stabil / _ _ eyivo / pages / {id} links, diselesaikan dalam bahasa pengunjung ketika diterbitkan. Blog posting menggunakan dokumen terstruktur JSON dengan situs media _ id dan halaman / post target, bukan body _ html.

{
  "type": "doc",
  "content": [{
    "type": "paragraph",
    "content": [{ "type": "text", "text": "Our story" }]
  }]
}

Gambar dan video uploads

upload- media- tool membuka sebuah picker berkas dalam MCP Apps klien seperti Claude. ChatGPT juga dapat menyediakan referensi lampiran host nya; sebuah lampiran obrolan Claude bukan sebuah referensi berkas OpenAI. Jangan pernah membuat sebuah download URL atau kirim berkas byte base64 sebagai argumen alat.

Codex dan Claude Code dapat memanggil persiapan -media- upload- alat, kemudian mengirim multipart file bytes ke upload _ url kembali dengan yang satu - gunakan upload _ token dalam waktu lima menit. Simpan rahasia token itu. REST klien dapat mengunggah dengan media mereka sendiri:write pembawa. Hanya upload selesai mengembalikan ID media untuk digunakan dalam isi; menerbitkan sebuah tiket tidak mengunggah berkas.

POST /api/v1/sites/{site}/media
Authorization: Bearer <media:write token>
Content-Type: multipart/form-data; boundary=<generated by HTTP client>

file: <original file bytes>

Domain kustom

Meminta domain

curl --request POST \
  --url https://app.eyivo.com/api/v1/sites/42/domains \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ey_your_token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: domain-request-example-com' \
  --data '{"domain":"www.example.com"}'

Sumber daya domain yang tertunda termasuk verification_token. Tambahkan yang diperlukan DNS catatan kepemilikan menggunakan nilai dikembalikan untuk domain Anda, tunggu DNS Progreasi, lalu sebut titik akhir aktivasi. Setelah aktif, panggil titik akhir primer jika itu harus menjadi nama host publik kanonikal.

Kolom sumber daya Domain: id, domain, site_id, is_primary, status, kondisional verification_token, dan penanda waktu. Rencana domain dan validasi domain gagal kembali 422.

11.

Respon validasi

{
  "message": "The title field is required.",
  "errors": {
    "title": ["The title field is required."]
  }
}

Respon otentikasi atau otorisasi

{
  "message": "Missing required scope [content:write]."
}

Batas saat ini dan daftar cek integrasi

REST v1 sengaja mengekspos subset fokus Eyivo.

Sebelum produksi

• Gunakan HTTPS dan memvalidasi yang diharapkan app.eyivo.com tuan rumah.
• Jauhkan token pembawa server- sisi dan redact header otorisasi dari log.
• Permintaan hanya perlu scope dan lebih suka bit - terbatas token pribadi bila mungkin.
• Gunakan kunci idempotensi yang unik untuk setiap penulisan logis dan jaga dari pengulangan.
• Perlakukan 401, 403, 404, dan 422 sebagai non- sementara kecuali permintaan yang mendasari atau perubahan kredensial.
• Gunakan backoff eksponensial dengan jitter untuk kegagalan sementara dan menghormati masa depan Retry-After tajuk.
• Bentuk koleksi bervariasi. Ikuti metadata dokumentasi setiap titik akhir; jangan asumsikan setiap hasil adalah daftar datar atau tak berpaginasi.