Laman utama / API

API

Bawa kemajuan Projek Kedai ke dalam sistem anda sendiri: langkah mana yang telah dicapai oleh projek, ke mana barang dihantar, dan sama ada Latihan sudah bersedia. Semua endpoint adalah baca sahaja; tiada pendaftaran atau API Key diperlukan.

Konvensyen asas

Base URL
https://www.icook.cloud
Pengesahan
Endpoint yang disenaraikan pada halaman ini tidak memerlukan sebarang kelayakan; endpoint akses kod menggunakan token dalam pautan itu sendiri sebagai kelayakan
Format
JSON (application/json; charset=utf-8); semua masa dalam UTC
Ralat
400 parameter tidak sah · 401 kod akses tiada · 404 tidak wujud; badan respons berbentuk {"error":"…"}
Permintaan rentas asal
Tiada header CORS dikembalikan — panggilan rentas asal dari pelayar akan disekat, sila panggil dari pelayan anda. Jika sambungan terus dari pelayar diperlukan, hantar e-mel kepada kami dengan domain asal.
Kadar
Tiada kuota tegar. Cache secara bertanggungjawab; meninjau kemajuan Projek Kedai sekali seminit sudah memadai, tidak perlu sekali sesaat
Versi
Tiada nombor versi. Medan hanya ditambah, tidak dibuang; jika perubahan yang memecahkan keserasian diperlukan, pemanggil yang diketahui akan dimaklumkan melalui e-mel terlebih dahulu

Endpoint inilah yang menggerakkan halaman awam laman web ini sendiri — apa yang anda lihat pada halaman projek, itulah yang dikembalikan oleh endpoint, tidak lebih tidak kurang.

Data terbuka

Tiada kelayakan diperlukan. Sesuai untuk membawa kemajuan projek ke dalam papan pemuka anda sendiri.

GET/api/projects

Senarai Projek Kedai yang sedang berjalan. Projek dengan status active.

MedanPenerangan
idNombor projek; parameter laluan untuk endpoint lain
name / biz_type / cityNama projek · jenis perniagaan · bandar
statusactive (sedang berjalan) · semua nilai lain menunjukkan status diarkibkan
current_stageLangkah semasa antara sembilan langkah, 1–9
noteNota latar belakang awam dalam satu ayat
track / cuisineSektor pemilihan tapak / kategori menu; nilai dikongsi dengan perpustakaan
submission_countBilangan cadangan yang diterima (kiraan sahaja, tiada kandungan)
stage_countsBilangan cadangan mengikut peringkat, dalam bentuk { "5": 12 }
created_atMasa penciptaan projek, UTC

GET/api/projects/:id

Butiran satu projek individu. Termasuk tiga medan status merentas peringkat tambahan berbanding respons senarai.

MedanPenerangan
…Termasuk semua medan daripada respons senarai
opening_status⑨ Istilah status kitaran Pembukaan (status sahaja, tiada data operasi)
training_status⑧ Istilah status kitaran Latihan
accepted_countBilangan cadangan yang diterima pakai

Pendapatan, kos, masalah, orang yang bertanggungjawab dan tarikh pembukaan langsung tidak dikembalikan sebagai medan — ini ialah garis merah reka bentuk, bukan ketinggalan.

GET/api/projects/:id/sites

Senarai pendek premis calon projek (hasil daripada ② Penilaian Lokasi).

MedanPenerangan
site_idPengecam premis dalam Perpustakaan Lokasi; butiran premis disimpan dalam Perpustakaan Lokasi, dan hanya rujukan disimpan di sini
external_title / external_urlTajuk dan pautan untuk premis di luar perpustakaan
statuspending (menunggu lawatan tapak) · visited (telah dilawati) · chosen (dipilih) · rejected (ditolak)
noteNota calon

Nota: `note` ialah medan awam dan dipaparkan secara terbuka bersama halaman projek. Anggap nota sebagai terbuka semasa menulisnya — jangan sertakan harga dasar anda, nama pesaing, atau sebarang penilaian yang tidak sepatutnya dilihat.

GET/api/projects/:id/menus

Senarai pendek menu calon projek (hasil daripada ① Diagnostik Projek). Strukturnya sama seperti premis calon dan hanya menyimpan rujukan menu_id.

MedanPenerangan
menu_idPengecam menu dalam Perpustakaan Menu
status / noteSama seperti premis calon

GET/api/projects/:id/shipments

Kemajuan penghantaran projek. Diselindungkan: hanya mengembalikan bilangan lot, tonggak semasa, tarikh ketibaan dan bilangan kotak.

MedanPenerangan
idNombor lot
cargo_classfood (makanan) · general (bukan makanan)
transport_modesea_fcl (muatan kontena penuh) · sea_lcl (muatan kurang daripada kontena penuh) · air (kargo udara) · ground (pengangkutan darat di AS)
cold_chainSama ada rantaian sejuk digunakan, 0 / 1
statusStatus senarai pembungkusan
nodedepart (berlepas) · transit (dalam perjalanan) · arrived (tiba di pelabuhan) · customs (pelepasan kastam) · final_mile (penghantaran akhir) · delivered (dihantar)
etaTarikh ketibaan dijangka di pelabuhan
item_count / carton_totalBilangan baris item / jumlah bilangan kotak

Hanya lot yang dimuktamadkan atau pada peringkat seterusnya dikembalikan. Nilai kargo, HS CODE, alamat penghantaran, pengangkut dan nombor bil muatan tidak pernah dikembalikan.

GET/api/projects/:id/training-readiness

Kesediaan ⑧ Latihan projek. Kiraan agregat sahaja; tiada senarai kakitangan atau maklumat peribadi.

MedanPenerangan
started / statusSama ada telah bermula · istilah status kitaran
staffed / plan_totalBilangan kakitangan sebenar / kuota kakitangan
cert_passed / cert_requiredItem pensijilan yang lulus / item pensijilan yang diperlukan
critical_passed / critical_required / critical_pendingItem kritikal lulus / diperlukan / belum lulus
hollowSama ada ia berada dalam keadaan kosong di mana memasukkan hanya satu item memaparkan skor penuh
readySama ada syarat Latihan untuk pembukaan telah dipenuhi

Kemajuan dikira berdasarkan item yang diperlukan, bukan baris yang dicipta — oleh itu `cert_required` biasanya jauh lebih besar daripada bilangan baris yang dimasukkan.

Endpoint akses kod

Pautan itu sendiri ialah kelayakan. Token dikeluarkan oleh kami bersama pautan perniagaan yang berkaitan; ia tidak boleh dipohon secara terbuka — pautan yang diterima hanya membuka dokumen yang berkaitan dengannya.

GET/api/ticket/:code

Status penilaian cadangan. code ialah kod resit 8 aksara yang dipaparkan pada halaman penghantaran berjaya.

MedanPenerangan
title / supplierTajuk cadangan / nama syarikat yang menghantar
stagePeringkat berkaitan, 1–9
statusnew (penyerahan baharu) · reviewing (sedang disemak) · accepted (diterima) · rejected (tidak diterima)
created_atMasa penyerahan, UTC

Isi kandungan cadangan, sebut harga dan lampiran tidak dikembalikan.

GET/api/quote/:token

Sebut harga pelanggan. Token datang daripada pautan /q/ yang kami keluarkan.

MedanPenerangan
title / category / stageTajuk sebut harga · kategori · peringkat
quote_amount / quote_currencyAmaun sebut harga untuk pelanggan dan mata wang
member_discountPeratusan diskaun ahli; 0 menunjukkan bahawa tiada tahap harga ahli ditetapkan
items[]Baris item: name · spec · unit · qty · sale_price · category · img_url
shipments[]Kemajuan penghantaran berkaitan (sama seperti di atas, data disamarkan)

Sebut harga yang mempunyai kata laluan semakan memerlukan `?pass=<kata-laluan-semakan>`; jika tidak, respons ialah 401. Harga kos, markup dan margin kasar tidak pernah dikembalikan.

GET/api/booking/:token

Destinasi pautan pelanggan senarai pembungkusan logistik. Token datang daripada pautan /logistics/f/ yang kami keluarkan; senarai pembungkusan diisi di freight.icook.cloud, dan titik akhir ini hanya mengembalikan pautan pelanggan yang sepadan.

MedanPenerangan
redirectPautan pelanggan freight, termasuk ?pass= apabila kata laluan semakan yang betul diberikan; null apabila tiada senarai pembungkusan yang sepadan
notePenjelasan apabila tiada senarai pembungkusan yang sepadan

Turut menyokong `?pass=`. Kandungan senarai pembungkusan tidak dikembalikan.

GET/api/booking-share/:token

Destinasi pautan ejen penghantaran senarai pembungkusan logistik. Token datang daripada pautan /logistics/s/ yang kami keluarkan; titik akhir ini hanya mengembalikan pautan ejen penghantaran freight yang sepadan.

MedanPenerangan
redirectPautan ejen penghantaran freight; null apabila tiada senarai pembungkusan yang sepadan
notePenjelasan apabila tiada senarai pembungkusan yang sepadan; kosong apabila destinasi wujud

Kandungan senarai pembungkusan tidak dikembalikan.

Cuba

curl https://www.icook.cloud/api/projects

# Projek tunggal
curl https://www.icook.cloud/api/projects/1

# Kemajuan penghantaran (data disamarkan)
curl https://www.icook.cloud/api/projects/1/shipments

# Kod pengesanan demo / sebut harga demo (dua yang digunakan dalam panduan)
curl https://www.icook.cloud/api/ticket/GUIDE2026
curl https://www.icook.cloud/api/quote/GUIDEQUOTE26

Apa yang tidak disediakan

  • Tiada endpoint tulis awam. Untuk menghantar cadangan, memohon keahlian, mengisi senarai pembungkusan, atau menukar kuantiti sebut harga, sila gunakan borang web — ia mengandungi langkah pencegahan penyalahgunaan yang diperlukan, dan permintaan yang memintas borang serta memanggil endpoint terus akan ditolak.
  • Kandungan cadangan, kos sebut harga dan senarai pelanggan tidak disediakan. Semua ini hanya boleh dilihat di antara muka pentadbir.
  • Maklumat pekerja tidak disediakan. Modul Latihan itu sendiri tidak menyimpan data seperti identiti, alamat atau gaji; ia hanya menyimpan nombor pekerja dan jawatan.
  • Eksport pukal tidak disediakan. Jika anda memerlukan data sejarah, hantar e-mel kepada kami dan nyatakan tujuan penggunaan.

Perlu mengintegrasikan data, sambungan terus dari pelayar, atau medan yang tidak ada di halaman ini? E-mel [email protected] dengan menyatakan tujuan penggunaan dan jumlah panggilan. Menggunakan API ini bermakna anda menerima Terma Perkhidmatan; untuk pemprosesan data, lihat Dasar Privasi.