Otomatisasi
Otomatiskan pembuatan dokumen menggunakan Lark Base Automation. Dokumen dibuat otomatis saat record dibuat, diperbarui, atau ketika kondisi tertentu terpenuhi.
1. Aktifkan HTTP Trigger
Section titled “1. Aktifkan HTTP Trigger”- Buka tab Template.
- Buka bagian Otomatisasi lalu bentangkan HTTP Trigger.
- Salin URL webhook yang tersedia.
2. Siapkan Lark Base Automation
Section titled “2. Siapkan Lark Base Automation”- Buka Base Anda → Automations.
- Buat automation baru.
- Tambahkan pemicu (misalnya “When record is created”).
- Tambahkan aksi: Send HTTP Request.
- Konfigurasi: Method =
POST, URL = URL webhook tadi +?recordId={{record_id}}. - Tambahkan header:
X-Webhook-API-Key: <kunci API Anda>.
Format URL webhook:
https://api.automadoc.cc/api/webhook/templates/{templateId}/generate?recordId={recordId}Kunci yang dipakai bisa berupa kunci API milik template itu sendiri atau kunci API perusahaan, yang dibuat admin aplikasi di Portal Perusahaan di bawah Perusahaan → Kunci API dan berlaku untuk semua template. Respons mencantumkan generationIds dokumen-dokumen yang dimulainya; GET /api/v1/documents/{generationId} melaporkan status masing-masing.
Kirim dokumen untuk ditandatangani
Section titled “Kirim dokumen untuk ditandatangani”Untuk mengirim setiap dokumen yang dibuat agar ditandatangani, beri langkah Send HTTP Request sebuah body JSON (Content-Type: application/json):
{ "sign": {} }Penanda tangan diambil dari record, sesuai pengaturan di Tanda tangan lewat otomatisasi pada tab Template; tautan dan kata sandi buatan untuk orang luar ditulis kembali ke record agar otomatisasi Anda dapat mengirimkannya lewat email. Untuk menyebutkan penanda tangan langsung di permintaan, berikan signers per peran, seperti yang diterima API dokumen. Lihat Tanda tangan elektronik.
Resep untuk setiap jenis pemicu
Section titled “Resep untuk setiap jenis pemicu”Setiap resep diakhiri dengan langkah yang sama: Send HTTP Request dengan method POST, URL webhook diikuti ?recordId= dan ID record yang ditemukan pemicu, serta header X-Webhook-API-Key. Hanya pemicunya yang berbeda. Nama pemicu bisa sedikit berbeda antarversi Lark.
Saat record ditambahkan: dokumen untuk setiap record baru, misalnya penawaran harga begitu sebuah permintaan dimasukkan. Pilih pemicu untuk record baru, lalu tabelnya.
Saat record diedit: dokumen baru setiap kali record berubah. Pilih pemicu untuk record yang diubah dan field yang dipantau (misalnya hanya Amount dan Customer), agar edit yang tidak berkaitan tidak membuat dokumen baru.
Saat record memenuhi kondisi: dokumen pada saat record mencapai suatu keadaan, misalnya Status menjadi Approved. Ini resep yang paling umum: berjalan sekali, ketika kondisi mulai terpenuhi.
Saat tanggal tercapai: dokumen pada tanggal yang ada di record, misalnya surat pengingat pada Due date, atau tujuh hari sebelumnya. Pilih field tanggal dan selisih harinya.
Sesuai jadwal: dokumen pada waktu yang ditentukan, misalnya setiap Senin pukul 9:00. Jadwal tidak memiliki record sendiri, jadi tambahkan langkah Find records (misalnya “Status is Open”), lalu kirim HTTP request untuk record yang ditemukan, menggunakan ID record-nya. Pastikan lewat uji coba bahwa request dikirim sekali per record.
Dari AnyCross atau klien HTTP apa pun
Section titled “Dari AnyCross atau klien HTTP apa pun”AnyCross dan alat integrasi lain dapat memanggil AutomaDoc dengan node HTTP request biasa. Untuk membuat dokumen dari record Base, gunakan HTTP Trigger di atas. Untuk membuat dokumen dari data yang tidak ada di Base (formulir, ERP), gunakan API dokumen, yang menerima data sebagai JSON:
| Pengaturan | Nilai |
|---|---|
| Method | POST |
| URL | https://api.automadoc.cc/api/v1/templates/{templateId}/documents?wait=20 |
| Header | X-Webhook-API-Key: kunci API template Anda atau kunci API perusahaan |
| Header | Content-Type: application/json |
| Body | {"data": { … the fields of your document … }} |
Dengan ?wait=20, respons tiba setelah dokumen siap, dan downloadUrl-nya bisa diteruskan ke node berikutnya, untuk melampirkan file ke pesan atau menyimpannya ke Drive.
Saat permintaan ditolak
Section titled “Saat permintaan ditolak”Jika penolakan berkaitan dengan paket Anda, HTTP Trigger membalas 403 dengan code di body JSON:
code |
Alasan | Yang perlu dilakukan |
|---|---|---|
AUTOMATION_NOT_INCLUDED |
Perusahaan Anda tidak memiliki paket Pro, trial aktif, maupun seat Business. | Beli seat Business atau Pro di halaman Tagihan pada Portal Perusahaan. |
QUOTA_EXCEEDED |
Dokumen otomatis yang termasuk dalam seat Business dan kuota gratis bulanan sudah habis, dan tidak ada paket dokumen yang masih berisi dokumen. | Beli paket dokumen di halaman Tagihan, atau tunggu periode berikutnya. |
TEMPLATE_DISABLED |
Template dikunci: perusahaan Anda memiliki lebih banyak template daripada yang diizinkan paketnya. | Naikkan batas template di halaman Tagihan (paket, seat, atau Template tambahan), atau hapus satu template. Template yang dikunci kembali dalam 24 jam. |
X-Webhook-API-Key yang tidak ada ditolak dengan 401 (API_KEY_MISSING), dan kunci yang salah atau tidak membuka template ini dengan 403 (API_KEY_INVALID).
HTTP Trigger menerima 300 permintaan per menit per template, batas tersendiri: otomatisasi Lark mengirim setiap record sekali saja dan tidak mencoba lagi, jadi batas 60 dari API dokumen tidak berlaku untuknya. Dokumennya dihitung dalam batas 600 dokumen per menit per perusahaan, bersama API dokumen. Jika salah satu batas terlampaui, HTTP Trigger menjawab 429 (RATE_LIMITED) dan tidak membuat dokumen untuk permintaan itu, jadi bagi impor yang sangat besar ke dalam beberapa menit. Setiap penolakan lain juga memiliki code, misalnya RECORD_ID_REQUIRED (400, tanpa recordId) dan WORKER_UNAVAILABLE (502, coba lagi sebentar lagi).
Notifikasi keluar
Section titled “Notifikasi keluar”Terima notifikasi saat dokumen selesai dibuat. Cocok untuk memicu otomatisasi lanjutan.
- Di tab Template, buka bagian Otomatisasi lalu aktifkan Callback Webhook.
- Masukkan URL webhook Anda.
- Opsional, tambahkan Bearer token untuk autentikasi.
AutomaDoc mengirim POST dengan body JSON berikut:
{ "url": "https://api.automadoc.cc/...?expires=...&signature=...", "filename": "Invoice-INV-2024-001.pdf", "fields": { "Customer_Name": "Acme Corp", "Total_Amount": "1,500.00" }}url: tautan unduhan bertanda tangan, berlaku 2 jam.filename: nama file akhir setelah pola nama file diterapkan.fields: nilai sederhana record yang dipakai untuk pembuatan dokumen: teks, angka, tanggal, dan sejenisnya, seperti yang dicetak di dokumen. Record tertaut, daftar, dan lampiran tidak disertakan.warnings: hanya jika pembuatan dokumen memberi peringatan, misalnya gambar yang tidak dapat diambil (disebut dengan nama field dan host URL-nya).
Jika Bearer token disetel, token dikirim melalui header Authorization.
Contoh penggunaan
Section titled “Contoh penggunaan”- Memicu otomatisasi Lark lanjutan
- Mengirim notifikasi Lark Messenger lewat bot
- Integrasi dengan alur Lark Approval. Untuk membuat dokumen saat permintaan disetujui, lihat Dokumen persetujuan, yang tidak memerlukan otomatisasi
- Mengarsipkan dokumen ke Lark Docs atau Drive