Tài liệu APITài liệu kỹ thuật

Tài liệu API từ mô tả endpoint của bạn

Bàn giao từ 1 ngàyBao gồm chỉnh sửaKiểm tra chất lượng
Các gói
Bảo vệ thanh toánChi tiết
  • Chỉnh sửa trong phạm vi gói là miễn phí.
  • Nếu bạn không phản hồi trong vòng 3 ngày sau khi bàn giao, kết quả sẽ được tự động chấp nhận.
Đặt hàng · 1.057.000 ₫

Số tiền được tạm giữ khi bạn thanh toán và chỉ được chuyển khi bạn chấp nhận kết quả.

Tài liệu API từ mô tả endpoint của bạn

Ví dụ kết quả

Ví dụ cho gói Tiêu chuẩn

Bộ quy trình SOP: mở và đóng cửa cho quán cà phê nhỏ

SOP-02: Đóng cửa quán

Mục đíchĐể quán sạch, an toàn và sẵn sàng cho ca sáng
Ai làmBarista ca đóng; trưởng ca ký xác nhận
Khi nàoBắt đầu 17:30, khóa cửa 18:00, xong trước 18:45
Cần cóPhiếu kiểm tra đóng cửa, chìa khóa máy tính tiền, giỏ đồ vệ sinh, khăn xanh

Trước khi bắt đầu

Cảnh báo: Không bao giờ ngắt cầu dao tổng trên tường. Tủ lạnh và hệ thống báo động dùng chung tủ điện.

Các bước

  1. 17:30, lật biển ở cửa sang "Nhận order cuối". Khách đã ở trong quán được ngồi đến 18:00.
  2. Chuyển máy pha sang chế độ xả. Nhấn giữ nút ly 5 giây. Bạn sẽ thấy: chữ "RINSE" nhấp nháy và nước nóng chảy qua cả hai họng pha khoảng 2 phút.
  3. Tháo tay cầm pha và ngâm trong thùng đen có một viên vệ sinh. Ngâm 20 phút.
  4. Chuyển bánh ngọt và sandwich vào tủ lạnh phía sau. Món nào mở trong ngày thì dán nhãn ngày hôm nay và "Dùng trước ngày mai".
  5. Ghi nhiệt độ tủ lạnh vào sổ. Bạn sẽ thấy: từ 1 °C đến 5 °C. Tủ nào trên 5 °C, làm bước 12 trước.
  6. 18:00, khóa cửa trước và lật biển sang "Đã đóng cửa".
  7. Chốt máy tính tiền. Nhấn MENU, chọn "Cuối ngày", rồi "Báo cáo Z". Bạn sẽ thấy: báo cáo in ra kèm tổng doanh thu hôm nay. Không đếm tiền tại quầy; mang khay tiền vào văn phòng.

(Bước 8–14: sàn, rác, báo động và ghi chú bàn giao.)

Nếu có sự cố

Sự cốCách xử lý
Tủ lạnh trên 5 °CChuyển đồ sang tủ thứ hai, ghi giờ và nhiệt độ, nhắn trưởng ca
Báo cáo Z không inThay cuộn giấy; vẫn lỗi thì ghi tổng trên màn hình và chụp ảnh
Không bật được báo độngKiểm tra cửa sau đã đóng hẳn chưa; cửa mở thì báo động không kích hoạt

Ký xác nhận

Barista ca đóng: tên, giờ. Trưởng ca: ký tắt.

Rà soát lần cuối: [ngày]. Rà soát lại khi thay máy pha hoặc máy tính tiền.

Khách hàng: quán cà phê Hoa Chuông, 22 chỗ ngồi, 7 nhân viên làm ca xoay vòng Đầu vào: ghi âm của chủ quán, một danh sách kiểm tra viết tay và 9 ảnh quầy, máy pha cà phê, màn hình máy tính tiền Bàn giao: bộ 6 SOP (4.600 từ): mở cửa, đóng cửa, quản lý tiền mặt, sổ nhiệt độ tủ lạnh, vệ sinh sâu máy pha, xử lý khiếu nại. Dưới đây: trích quy trình đóng cửa.

Khách hàng và mọi thông tin đều là giả định.

Về dịch vụ này

Lập trình viên đánh giá một API qua tài liệu chỉ trong vài phút: nếu xác thực hoặc yêu cầu đầu tiên không chạy, họ sẽ rời đi. Chúng tôi viết tài liệu tham chiếu và hướng dẫn API từ mô tả endpoint, tệp OpenAPI hoặc mã mẫu của bạn: xác thực, base URL, từng endpoint với tham số, ví dụ request và response, mã lỗi, giới hạn tần suất và phân trang. Phần bắt đầu nhanh hướng dẫn lệnh gọi thành công đầu tiên trong vài bước.

Bao gồm những gì

  • Bạn nhận được gìTài liệu API dạng Markdown với các khối mã, sẵn sàng cho ReadMe, GitBook, Docusaurus hoặc repository của bạn. Chúng tôi viết từ những gì bạn gửi, không tự gọi API của bạn.
  • Bắt đầu nhanhTừ khóa API đến lệnh gọi đầu tiên
  • Tham chiếu endpointTham số, kiểu dữ liệu, ví dụ
  • Lỗi và giới hạnMã lỗi, ý nghĩa, lời khuyên thử lại
  • Mã mẫucURL cùng một ngôn ngữ bạn chọn
  • Thuật ngữ nhất quánCùng tên như trong schema của bạn

Cách hoạt động

  1. 1
    Yêu cầuBạn dán hoặc đính kèm endpoint và ví dụ
  2. 2
    Cấu trúc và nội dungChúng tôi viết tài liệu tham chiếu và hướng dẫn
  3. 3
    Bàn giaoBạn nhận Markdown sẵn sàng xuất bản

Chúng tôi cần gì từ bạn

Mô tả endpoint hoặc tệp OpenAPI hay Postman dán dưới dạng văn bản, thông tin xác thực, ví dụ request và response, mã lỗi và người dùng API của bạn là ai.

Chúng tôi sẽ hỏi bạn:

  • API làm gì và ai sử dụng?
  • Xác thực hoạt động thế nào?
  • Ngoài cURL, mã mẫu nên dùng ngôn ngữ nào?
  • Tài liệu sẽ được xuất bản ở đâu?

So sánh các gói

Các góiCơ bảnBắt đầu nhanh và tối đa 5 endpoint515.000 ₫Tiêu chuẩnTối đa 20 endpoint kèm hướng dẫn1.057.000 ₫Cao cấpTối đa 50 endpoint, tài liệu đầy đủ2.141.000 ₫
Thời hạn1 ngày3 ngày5 ngày
Số lần chỉnh sửa123
Độ dàitối đa 2.000 từtối đa 6.000 từtối đa 14.000 từ
Endpointtối đa 5tối đa 20tối đa 50
Ngôn ngữ mã mẫucURLcURL + 1cURL + 2
Đặt hàng Cơ bảnĐặt hàng Tiêu chuẩnĐặt hàng Cao cấp

Bảo vệ thanh toán

Bạn thanh toán khi đặt hàng, nhưng tiền chỉ được chuyển cho kết quả đã được chấp nhận.

  • Giá cố địnhGiá gói không thay đổi sau khi bạn thanh toán.
  • Số tiền được tạm giữKhi bạn thanh toán, số tiền chỉ được tạm giữ. Tiền được chuyển cho dịch vụ khi bạn chấp nhận kết quả.
  • Kiểm tra trước khi bàn giaoMọi kết quả đều được kiểm tra chất lượng trước khi đến tay bạn, và bạn xem được kết quả trên trang đơn hàng trước khi chấp nhận.
  • Chỉnh sửa miễn phíYêu cầu chỉnh sửa trong phạm vi bản yêu cầu của bạn, với số lần mà gói cho phép.
  • Tự động chấp nhận sau 3 ngàyNếu trong vòng 3 ngày sau khi bàn giao, bạn không chấp nhận kết quả cũng không yêu cầu chỉnh sửa, kết quả sẽ được tự động chấp nhận. Nếu bạn nhắn tin trong chat đơn hàng sau khi bàn giao, đơn hàng sẽ chờ; sau khi trả lời, chúng tôi có thể tính lại 3 ngày từ đầu và sẽ thông báo trong chat.
  • Làm lại hoặc hoàn tiền toàn bộNếu kết quả không đúng với yêu cầu của bạn và các lần chỉnh sửa không khắc phục được, hoặc công việc kéo dài quá gấp đôi thời hạn, hãy nhắn tin trong chat đơn hàng: chúng tôi sẽ làm lại hoặc hoàn tiền toàn bộ.
Cách hoạt động →

Hỏi đáp

Các bạn có thể làm từ đặc tả OpenAPI của chúng tôi không?

Có, hãy dán YAML hoặc JSON vào yêu cầu. Chúng tôi chuyển phần mô tả trong đó thành các trang tham chiếu dễ đọc và bổ sung những chỗ trống bạn chỉ ra.

Các bạn có kiểm tra các ví dụ không?

Chúng tôi không gọi API của bạn. Ví dụ được xây dựng từ mẫu request và response của bạn, vì vậy hãy chạy thử một lần trước khi xuất bản.

Các bạn có viết tài liệu SDK không?

Có, nếu bạn gửi chữ ký phương thức và ví dụ sử dụng. Mỗi SDK được tính vào khối lượng của gói.

Các gói
Đặt hàng · 1.057.000 ₫· 3 ngày