Lewati ke konten
Delivery API
Sebelum Anda merencanakan berdasarkan sebuah fitur, periksa status kapabilitas.

IkhtisarMulai di sini

Cara kerja Atlas

Organisasi, situs, lingkungan, kontrak situs, penerbitan, dan pengiriman dalam satu halaman.

Halaman ini diterjemahkan dari bahasa Inggris. Jika ada perbedaan, versi bahasa Inggris yang berlaku. Baca dalam bahasa Inggris

Konsep Penjelasan
Organisasi Perusahaan Anda. Organisasi memiliki situs, orang, dan paketnya.
Situs Satu situs web. Konten, media, akses pengguna, dan pengaturan tidak pernah tercampur antarsitus.
Lingkungan Setiap situs memiliki Development dan Production. Anda bekerja di Development; Production hanya menyajikan rilis yang telah disetujui.
Kontrak situs Deskripsi JSON dari situs web Anda: komponen beserta bidang bertipenya, tipe halaman, koleksi, global header/footer, profil media, dan token desain.
Halaman Sebuah rute di situs web Anda (misalnya /about), tersusun dari beberapa seksi. Setiap seksi adalah salah satu komponen dalam kontrak Anda, beserta nilai bidangnya.
Entri Satu item dalam koleksi, seperti produk atau artikel berita.
Global Konten yang dipakai bersama di banyak halaman, seperti header dan footer situs.
Token pengiriman Token khusus server yang dipakai situs web Anda untuk membaca konten terbit pada satu lingkungan.
Editor in Studio ──draft──▶ Atlas (Development) ──publish──▶ published revision
│
your website server ◀── Delivery API (HTTPS, delivery token)
│
your components render it ──▶ visitors
  1. Developer Anda mendeskripsikan situs web dalam kontrak situs. Admin situs mengaktifkannya di Studio.
  2. Editor membuat dan mengubah halaman serta entri sebagai draf. Draf tidak pernah tampil di situs web publik.
  3. Editor melakukan pratinjau draf di dalam desain situs web Anda yang sebenarnya, lalu menerbitkan-nya. Setiap penerbitan menjadi revisi yang tidak dapat diubah, sehingga Anda dapat mengembalikannya.
  4. Situs web Anda membaca konten terbit dari Delivery API dengan token pengirimannya, hanya dari kode server.
  5. Atlas mengirim webhook bertanda tangan saat penerbitan, sehingga situs web Anda hanya menyegarkan halaman yang terdampak.
  • Setiap situs baru dimulai di Development. Konten disunting dan diterbitkan di sana.
  • Production nonaktif sampai admin situs mengaktifkannya, setelah sebuah rilis lolos semua pemeriksaan dan orang yang berhak menyetujui telah menyetujuinya.
  • Production hanya menyajikan rilis live yang bertanda tangan: cuplikan konten tersetujui yang dibekukan. Menyunting Development tidak pernah mengubah Production sampai rilis tersetujui berikutnya.
  • Berpindah lingkungan di Studio hanya mengubah apa yang sedang Anda lihat. Konten tidak pernah berubah.

Selengkapnya: Development dan Production.

Atlas tidak berjalan di situs web Anda. Developer Anda menambahkan sedikit kode:

  • klien khusus server untuk Delivery API;
  • perenderan seksi melalui komponen Anda yang sudah ada;
  • fallback: jika Atlas tidak dapat dijangkau atau tidak ada yang terbit untuk suatu halaman, situs menyajikan konten bawaannya;
  • rute pratinjau draf, penerima webhook, dan laporan build.

Panduan koneksi menjelaskan masing-masing langkahnya.