# Wefluence API Bawa data kampanye, konten, dan performa kreator ke sistem timmu secara otomatis. ```bash curl https://api.wefluence.app/v1/campaigns \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python import os, requests r = requests.get( "https://api.wefluence.app/v1/campaigns", headers={"Authorization": f"Bearer {os.environ['WEFLUENCE_API_KEY']}"}, ) print(r.json()) ``` ```javascript const res = await fetch("https://api.wefluence.app/v1/campaigns", { headers: { Authorization: `Bearer ${process.env.WEFLUENCE_API_KEY}` }, }); console.log(await res.json()); ``` ## Mulai dari sini - [Mulai cepat](https://docs.wefluence.app/quickstart/): Panggil API pertamamu dalam 5 menit. - [Key dan autentikasi](https://docs.wefluence.app/authentication/): Cara dapat key dan mengatur aksesnya. - [Referensi API](https://docs.wefluence.app/reference/): Semua endpoint, parameter, dan contoh respons. ## Yang bisa kamu bangun - [Laporan harian otomatis](https://docs.wefluence.app/guides/daily-sync/): Tarik konten dan views ke database timmu setiap hari. - [Google Sheets](https://docs.wefluence.app/guides/google-sheets/): Isi spreadsheet tanpa menyiapkan server. - [Asisten AI](https://docs.wefluence.app/guides/ai-assistants/): Tanya data kampanye lewat asisten yang kamu pakai. ## Data yang tersedia | Data | Isi | Referensi | | --- | --- | --- | | Kampanye | Status, tarif, budget, tenggat | [Kampanye](https://docs.wefluence.app/reference/campaigns/) | | Ringkasan | Jumlah konten, views, dan biaya per kampanye | [Ringkasan kampanye](https://docs.wefluence.app/reference/campaign-stats/) | | Konten | Link, platform, status, views, dan engagement | [Konten](https://docs.wefluence.app/reference/content/) | | Kreator | Konten disetujui, views, dan nominal dibayar | [Kreator](https://docs.wefluence.app/reference/creators/) | | Tagihan | Nomor, status, dan rincian tagihan | [Tagihan](https://docs.wefluence.app/reference/invoices/) | API ini hanya membaca data. Bikin kampanye, bayar, dan review konten tetap di aplikasi Wefluence. ## Pertanyaan umum ### Apa itu Wefluence API? API REST baca-saja dan server MCP untuk menarik data kampanye, konten, kreator, dan tagihan satu akun brand Wefluence ke dashboard, database, spreadsheet, atau asisten AI. ### Bisakah API membuat kampanye atau membayar? Tidak. API hanya membaca data. Bikin kampanye, bayar, dan review konten tetap di aplikasi Wefluence. ### Bagaimana cara mendapat API key? Buka **Pengaturan**, lalu **API key** di aplikasi Wefluence. Key hanya tampil sekali, berlaku 12 bulan, dan satu akun bisa punya sampai 5 key aktif. ### Bisakah dipakai dari asisten AI? Bisa. Claude, Cursor, VS Code, dan alat lain yang mendukung server MCP jarak jauh bisa tersambung ke `https://api.wefluence.app/v1/mcp` dengan key yang sama. Caranya ada di [Asisten AI](https://docs.wefluence.app/guides/ai-assistants/). ### Berapa batas pemakaiannya? 60 panggilan per menit dan 5.000 panggilan per hari untuk tiap key. Kuota harian reset pukul 00.00 WIB. ### Apakah views-nya real time? Tidak. API memberi views terverifikasi, sama dengan halaman Performa di aplikasi. Angkanya berubah saat konten diverifikasi lagi. --- # Mulai cepat Panggil Wefluence API untuk pertama kali dalam 5 menit. ## Siapkan key Buka **Pengaturan**, lalu **API key** di aplikasi Wefluence, dan buat key baru. Centang izin yang dibutuhkan. Key hanya tampil sekali, jadi langsung simpan sebagai environment variable. ```bash export WEFLUENCE_API_KEY="wfb_live_xxxxxxxx" ``` ```powershell setx WEFLUENCE_API_KEY "wfb_live_xxxxxxxx" ``` Mau coba tanpa menyentuh data asli? Minta key `wfb_test_` yang membaca akun contoh ke [hello@wefluence.id](mailto:hello@wefluence.id). ## Cek sambungan Panggil `/v1/me` untuk memastikan key-mu bekerja. ```bash curl https://api.wefluence.app/v1/me \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python import os, requests headers = {"Authorization": f"Bearer {os.environ['WEFLUENCE_API_KEY']}"} print(requests.get("https://api.wefluence.app/v1/me", headers=headers).json()) ``` ```javascript const headers = { Authorization: `Bearer ${process.env.WEFLUENCE_API_KEY}` }; const res = await fetch("https://api.wefluence.app/v1/me", { headers }); console.log(await res.json()); ``` Kalau berhasil, kamu mendapat nama akun dan sisa kuota: ```json { "object": "account", "brand": { "name": "Nama Brand" }, "key": { "label": "Dashboard marketing", "mode": "live", "scopes": ["campaigns:read", "content:read"], "expires_at": "2027-11-02T00:00:00.000Z" }, "quota": { "per_minute": 60, "per_day": 5000, "used_today": 1 } } ``` ## Ambil kampanye ```bash curl "https://api.wefluence.app/v1/campaigns?status=active" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python r = requests.get( "https://api.wefluence.app/v1/campaigns", headers=headers, params={"status": "active"}, ) campaigns = r.json()["data"] ``` ```javascript const res = await fetch("https://api.wefluence.app/v1/campaigns?status=active", { headers }); const { data: campaigns } = await res.json(); ``` ## Ambil konten Pakai `id` kampanye dari langkah sebelumnya. ```bash curl "https://api.wefluence.app/v1/campaigns/abc123/content?status=approved" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python r = requests.get( f"https://api.wefluence.app/v1/campaigns/{campaigns[0]['id']}/content", headers=headers, params={"status": "approved"}, ) for item in r.json()["data"]: print(item["url"], item["views"]["verified"]) ``` ```javascript const url = `https://api.wefluence.app/v1/campaigns/${campaigns[0].id}/content?status=approved`; const { data } = await (await fetch(url, { headers })).json(); data.forEach((item) => console.log(item.url, item.views.verified)); ``` ## Langkah berikutnya - [Sinkron harian](https://docs.wefluence.app/guides/daily-sync/): Tarik semua halaman dan simpan tanpa data dobel. - [Arti angka](https://docs.wefluence.app/data/): Pahami views, engagement, dan nominal dibayar. - [Referensi API](https://docs.wefluence.app/reference/): Lihat semua endpoint dan parameternya. --- # Key dan autentikasi Cara kerja key, scope, dan mode live atau test. Semua permintaan memakai key di header `Authorization`. ```bash Authorization: Bearer wfb_live_xxxxxxxx ``` ## Satu key, satu akun Satu key membaca satu akun brand. Kalau kamu mengelola beberapa brand, pakai satu key untuk tiap akun. Key dibuat sendiri di aplikasi Wefluence, lewat **Pengaturan**, lalu **API key**. Beri nama, lalu centang izin yang dibutuhkan. ## Scope Scope menentukan data yang bisa dibaca sebuah key. | Scope | Isi | Bawaan | | --- | --- | --- | | `campaigns:read` | Daftar kampanye, detail, dan ringkasan konten serta views | Ya | | `content:read` | Konten dan kreator per kampanye | Ya | | `finance:read` | Sisa dana, nominal dibayar, biaya layanan, dan tagihan | Tidak | Tanpa `finance:read`, ringkasan kampanye tetap keluar tanpa blok `money`. ## Live dan test | Awalan | Membaca | | --- | --- | | `wfb_live_` | Akun brand-mu | | `wfb_test_` | Akun contoh, untuk mencoba tanpa menyentuh data asli | ## Masa berlaku Key berlaku 12 bulan, dan satu akun bisa punya sampai 5 key aktif. Untuk mengganti key, buat key baru, pindahkan sistemmu, lalu cabut yang lama. Key yang dicabut langsung berhenti bekerja dan tidak bisa dihidupkan lagi. Baca juga [cara menjaga key tetap aman](https://docs.wefluence.app/guides/key-safety/). --- # Arti angka Cara membaca views, engagement, dan nominal dibayar. Angka di API memakai aturan yang sama dengan halaman Performa di aplikasi. Jadi hasilnya bisa langsung kamu cocokkan. ## Views - **Views terverifikasi** sudah diperiksa, jadi bukan angka real time. Angkanya berubah saat konten diverifikasi lagi. - **Views bisa melewati budget.** Konten yang terus jalan sesudah budget habis tetap tercatat, jadi `cost_per_1000_views` bisa lebih rendah dari tarif kampanye. - **Kampanye per video** dibayar per konten, jadi views-nya bisa 0 walau kontennya sudah dibayar. - `views.flagged` bernilai `true` kalau views konten ditandai bermasalah. Angkanya tetap ikut total, sama seperti di aplikasi. ## Engagement Engagement hanya ada untuk konten yang sudah dipindai, jadi nilainya bisa `null`. Bandingkan `items_with_data` dengan `items_counted` di ringkasan untuk melihat cakupannya. `shares` bernilai `null` di platform yang tidak menyediakannya, seperti YouTube dan Instagram. `null` berarti tidak tersedia, bukan nol. ## Uang - Semua nominal memakai rupiah bilangan bulat. - `paid_to_creators` tidak termasuk biaya layanan dan dana belanja. - `paid_amount` dicatat per pendaftaran, bukan per konten. Karena itu nominalnya ada di [Kreator](https://docs.wefluence.app/reference/creators/), bukan di [Konten](https://docs.wefluence.app/reference/content/). ## Status konten | Status | Artinya | | --- | --- | | `pending_review` | Menunggu keputusanmu | | `approved` | Sudah disetujui | | `rejected` | Ditolak, alasannya ada di `rejection_reason` | Konten yang masih diperiksa tim belum muncul di daftar, sama seperti di aplikasi. Jumlahnya tetap terlihat di `in_admin_moderation` pada ringkasan. ## Hitungan lain - `applicants` menghitung pendaftaran, bukan kreator unik. - `as_of` menunjukkan kapan data dibaca. - `id` konten tetap sama setiap kali ditarik, jadi aman dipakai sebagai kunci unik di databasemu. - `creator.ref` tetap sama untuk kreator yang sama di satu akun. --- # Halaman dan cursor Cara mengambil daftar panjang sampai habis. Daftar dikirim per halaman. Pakai `limit` sampai 100, bawaannya 50. Kalau `has_more` bernilai `true`, kirim `next_cursor` sebagai `cursor` di permintaan berikutnya. ```bash GET /v1/campaigns/abc123/content?limit=100 GET /v1/campaigns/abc123/content?limit=100&cursor=eyJhIjoi... ``` ```json { "object": "list", "data": [], "has_more": true, "next_cursor": "eyJhIjoi...", "as_of": "2026-11-02T09:00:00.000Z" } ``` ## Aturan - Satu halaman bisa berisi kurang dari `limit`, bahkan kosong. Yang menentukan selesai hanya `has_more`. - Perlakukan cursor sebagai teks yang tidak perlu dibaca. - Cursor hanya berlaku untuk key dan daftar yang sama. - Urutan daftar tetap, tapi tidak mengikuti tanggal. Urutkan sendiri di sisimu kalau perlu. ## Contoh ```python import os, requests API = "https://api.wefluence.app/v1" HEADERS = {"Authorization": f"Bearer {os.environ['WEFLUENCE_API_KEY']}"} def get_all(path, **params): while True: page = requests.get(f"{API}{path}", headers=HEADERS, params=params).json() yield from page["data"] if not page["has_more"]: return params["cursor"] = page["next_cursor"] ``` ```javascript const API = "https://api.wefluence.app/v1"; const headers = { Authorization: `Bearer ${process.env.WEFLUENCE_API_KEY}` }; async function* getAll(path, params = {}) { while (true) { const qs = new URLSearchParams(params); const page = await (await fetch(`${API}${path}?${qs}`, { headers })).json(); yield* page.data; if (!page.has_more) return; params.cursor = page.next_cursor; } } ``` --- # Batas pemakaian Berapa banyak panggilan yang bisa dibuat, dan apa yang terjadi saat batasnya tercapai. ## Batas per key | Batas | Nilai | | --- | --- | | Per menit | 60 panggilan | | Per hari | 5.000 panggilan, reset pukul 00.00 WIB | | Isi per halaman | 100 baris | | Laporan | 30 file per hari, permintaan yang sama dalam 60 menit tidak dihitung | ## Melihat sisa kuota Pemakaian per hari, per key, dan per endpoint ada di aplikasi Wefluence, lewat **Pengaturan**, lalu **API key**. Setiap jawaban membawa header berikut: | Header | Isi | | --- | --- | | `X-RateLimit-Limit` | Batas per menit | | `X-RateLimit-Remaining` | Sisa dalam menit ini | | `X-RateLimit-Reset` | Waktu reset, dalam detik Unix | | `X-Daily-Limit` | Batas per hari | | `X-Daily-Remaining` | Sisa hari ini | ## Saat batas tercapai API menjawab `429` dengan header `Retry-After` dalam detik. Tunggu sebesar itu sebelum mencoba lagi. ```python import time r = requests.get(url, headers=headers) if r.status_code == 429: time.sleep(int(r.headers.get("Retry-After", "60"))) ``` ## Hemat panggilan - Tarik hanya kampanye yang aktif. Kampanye selesai cukup ditarik sekali lagi sesudah berakhir. - Butuh semua konten sekaligus? [Laporan](https://docs.wefluence.app/reference/reports/) memakai satu panggilan, berapa pun jumlah kontennya. - Butuh konten terbaik saja? [Konten teratas](https://docs.wefluence.app/reference/content/) memakai satu panggilan. - Ringkasan disimpan sampai 60 menit, atau 24 jam untuk kampanye selesai. Memanggilnya lebih sering tidak membuat angkanya lebih baru. - Kirim `If-None-Match` berisi `ETag` terakhir ke [Ringkasan kampanye](https://docs.wefluence.app/reference/campaign-stats/). API menjawab `304` tanpa isi kalau belum ada perubahan. --- # Error Format error dan arti tiap kodenya. Error memakai format RFC 9457 dengan `Content-Type: application/problem+json`. Pakai `code` untuk logika di sistemmu, karena isinya tidak berubah. ```json { "type": "https://docs.wefluence.app/errors/#rate_limited", "title": "Terlalu banyak permintaan", "status": 429, "code": "rate_limited", "detail": "Batas per menit tercapai.", "request_id": "req_7c21d0e4a1b2c3d4" } ``` Sertakan `request_id` saat bertanya ke tim kami. Nilainya juga ada di header `X-Request-Id`. ## Daftar kode | Status | Code | Artinya | Yang perlu dilakukan | | --- | --- | --- | --- | | 400 | `invalid_request` | Parameter tidak valid | Baca `detail`, lalu perbaiki parameternya | | 400 | `invalid_cursor` | Cursor rusak, atau dibuat untuk daftar atau key lain | Mulai lagi dari halaman pertama | | 401 | `invalid_key` | Key tidak ada, salah format, atau sudah dicabut | Periksa header `Authorization` | | 401 | `key_expired` | Masa berlaku key habis | Minta key baru | | 403 | `account_blocked` | Akun brand sedang diblokir | Hubungi tim kami | | 403 | `insufficient_scope` | Key tidak punya scope untuk data ini | Minta key dengan scope yang dibutuhkan | | 404 | `not_found` | Data tidak ada di akun ini | Periksa ID dan akun key-nya | | 405 | `method_not_allowed` | Metode tidak didukung | API memakai `GET`, alamat MCP memakai `POST` | | 429 | `rate_limited` | Batas per menit tercapai | Tunggu sesuai `Retry-After` | | 429 | `daily_limit_reached` | Batas harian tercapai | Coba lagi sesudah 00.00 WIB | | 500 | `internal_error` | Masalah di sisi kami | Coba lagi, sertakan `request_id` kalau berulang | | 503 | `api_disabled` | API sementara tidak tersedia | Coba lagi beberapa menit kemudian | --- # Versi dan perubahan Bagaimana API berubah tanpa merusak integrasimu. Versi ada di alamat, sekarang `/v1`. ## Aturan perubahan - Kolom baru bisa ditambah kapan saja, jadi pastikan sistemmu mengabaikan kolom yang belum dikenal. - Perubahan yang merusak integrasi selalu lewat versi baru. - `/v1` tetap jalan minimal 12 bulan sesudah penggantinya diumumkan. ## Riwayat | Versi | Perubahan | | --- | --- | | v1 | Rilis pertama: kampanye, ringkasan, konten, kreator, tagihan, dan server MCP | --- # Sinkron harian Tarik data kampanye ke database timmu setiap hari tanpa data dobel. Pola yang disarankan: tarik kampanye aktif sekali atau beberapa kali sehari, lalu ambil kontennya sampai `has_more` habis. ## Alurnya 1. Ambil daftar kampanye dengan `status=active`. 2. Untuk tiap kampanye, ambil konten sampai `has_more` bernilai `false`. 3. Simpan memakai `id` konten sebagai kunci unik, supaya penarikan ulang memperbarui baris yang sama. 4. Kampanye yang berakhir cukup ditarik sekali lagi sesudah `status` jadi `ended`. ## Contoh lengkap ```python import os, time, requests API = "https://api.wefluence.app/v1" HEADERS = {"Authorization": f"Bearer {os.environ['WEFLUENCE_API_KEY']}"} def get_all(path, **params): while True: r = requests.get(f"{API}{path}", headers=HEADERS, params=params, timeout=30) if r.status_code == 429: time.sleep(int(r.headers.get("Retry-After", "60"))) continue r.raise_for_status() page = r.json() yield from page["data"] if not page["has_more"]: return params["cursor"] = page["next_cursor"] for campaign in get_all("/campaigns", status="active", limit=100): for content in get_all(f"/campaigns/{campaign['id']}/content", limit=100): print(campaign["title"], content["url"], content["views"]["verified"]) ``` ```javascript const API = "https://api.wefluence.app/v1"; const headers = { Authorization: `Bearer ${process.env.WEFLUENCE_API_KEY}` }; async function* getAll(path, params = {}) { while (true) { const res = await fetch(`${API}${path}?${new URLSearchParams(params)}`, { headers }); if (res.status === 429) { const wait = Number(res.headers.get("retry-after") || 60); await new Promise((r) => setTimeout(r, wait * 1000)); continue; } const page = await res.json(); yield* page.data; if (!page.has_more) return; params.cursor = page.next_cursor; } } for await (const campaign of getAll("/campaigns", { status: "active", limit: 100 })) { for await (const content of getAll(`/campaigns/${campaign.id}/content`, { limit: 100 })) { console.log(campaign.title, content.url, content.views.verified); } } ``` ## Menjadwalkan Satu sampai empat kali sehari sudah cukup, karena views diperbarui saat konten diverifikasi. Pakai cron, GitHub Actions, atau penjadwal yang sudah ada di tempatmu. Kalau kamu mengelola beberapa brand, jalankan alur yang sama untuk tiap key. --- # Google Sheets Isi spreadsheet dengan data konten tanpa menyiapkan server. ## Simpan key Buka spreadsheet, pilih **Extensions**, lalu **Apps Script**. Di Project Settings, tambahkan Script property bernama `WEFLUENCE_API_KEY`. Jangan tulis key di dalam sel, karena semua orang yang membuka file bisa membacanya. ## Tempel skrip Ganti `abc123` dengan ID kampanye-mu. ```javascript function tarikKonten() { var key = PropertiesService.getScriptProperties().getProperty('WEFLUENCE_API_KEY'); var id = 'abc123'; var sheet = SpreadsheetApp.getActiveSheet(); sheet.clearContents(); sheet.appendRow(['Kreator', 'Platform', 'Link', 'Status', 'Views']); var cursor = ''; do { var url = 'https://api.wefluence.app/v1/campaigns/' + id + '/content?limit=100' + (cursor ? '&cursor=' + encodeURIComponent(cursor) : ''); var res = UrlFetchApp.fetch(url, { headers: { Authorization: 'Bearer ' + key } }); var page = JSON.parse(res.getContentText()); page.data.forEach(function (c) { sheet.appendRow([c.creator.name, c.platform, c.url, c.status, c.views.verified]); }); cursor = page.has_more ? page.next_cursor : ''; } while (cursor); } ``` ## Jalankan otomatis Di Apps Script, buka **Triggers** dan buat pemicu harian untuk fungsi `tarikKonten`. --- # Asisten AI Sambungkan asisten AI ke data kampanyemu lewat MCP. Lewat MCP, asisten AI bisa membaca kampanye dan kontenmu langsung, tanpa perlu menulis kode. Alat apa pun yang mendukung server MCP jarak jauh dengan header kustom bisa memakai dua nilai ini: | Isian | Nilai | | --- | --- | | Alamat | `https://api.wefluence.app/v1/mcp` | | Header | `Authorization: Bearer wfb_live_xxxxxxxx` | Daftar alatnya ada di [Server MCP](https://docs.wefluence.app/reference/mcp/). ## Claude Di Claude web atau Desktop: 1. Buka pengaturan Connectors, lalu tambah custom connector. 2. Isi alamat MCP di atas, dan pilih tanpa sign in. 3. Di Request headers, tambahkan `Authorization` dengan nilai `Bearer wfb_live_xxxxxxxx`. Di paket Team dan Enterprise, connector ditambahkan oleh Owner, dan semua anggota memakai key yang sama. Paket Free dibatasi satu custom connector. Di Claude Code: ```bash claude mcp add --transport http wefluence https://api.wefluence.app/v1/mcp \ --header "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ## Cursor Tambahkan ke `.cursor/mcp.json`: ```json { "mcpServers": { "wefluence": { "url": "https://api.wefluence.app/v1/mcp", "headers": { "Authorization": "Bearer ${env:WEFLUENCE_API_KEY}" } } } } ``` ## VS Code Tambahkan ke `.vscode/mcp.json`: ```json { "servers": { "wefluence": { "type": "http", "url": "https://api.wefluence.app/v1/mcp", "headers": { "Authorization": "Bearer ${input:wefluence-key}" } } } } ``` ## Agent buatan sendiri Di Claude API, pakai MCP connector dengan header beta `anthropic-beta: mcp-client-2025-11-20`: ```json { "mcp_servers": [{ "type": "url", "url": "https://api.wefluence.app/v1/mcp", "name": "wefluence", "authorization_token": "wfb_live_xxxxxxxx" }], "tools": [{ "type": "mcp_toolset", "mcp_server_name": "wefluence" }] } ``` Agent dengan model lain bisa memanggil API langsung. Berikan [openapi.yaml](https://docs.wefluence.app/openapi.yaml) sebagai daftar alatnya. ## Beberapa brand Satu key membaca satu akun. Kalau punya beberapa brand, tambahkan satu sambungan untuk tiap key, dengan nama berbeda seperti `wefluence-brand-a` dan `wefluence-brand-b`. ## Prompt siap salin Laporan harian, untuk asisten yang sudah tersambung: ```text Pakai alat Wefluence. Ambil semua kampanye aktif, lalu untuk tiap kampanye pakai get_campaign_stats untuk jumlah konten disetujui dan total views, dan get_top_content untuk 10 konten teratas beserta link dan nama kreatornya. Sebutkan waktu as_of, dan beri tahu kalau data engagement belum lengkap. shares null berarti tidak tersedia, bukan nol. ``` Laporan lengkap sebagai file: ```text Pakai alat Wefluence. Cari kampanye yang saya sebut, lalu buat laporannya dengan create_campaign_report format xlsx, dan berikan link unduhannya. Jangan menarik semua konten ke percakapan. ``` Bikin integrasi, untuk asisten coding apa pun: ```text Bantu saya menyambungkan sistem ini ke Wefluence API. Baca dulu https://docs.wefluence.app/llms.txt dan https://docs.wefluence.app/openapi.yaml. Ambil key dari environment variable WEFLUENCE_API_KEY, jangan tulis key di kode atau log. Tarik per kampanye, ikuti next_cursor sampai has_more false, dan tunggu sesuai Retry-After kalau kena 429. Pakai id konten sebagai kunci unik supaya penarikan ulang tidak membuat data dobel. Perlakukan null sebagai data tidak tersedia, bukan nol. ``` ## Berkas untuk AI Setiap halaman docs punya versi Markdown. Tombol **Salin halaman** di kanan atas menyalinnya, dan bisa langsung membukanya di asisten AI. | Berkas | Isi | | --- | --- | | [llms.txt](https://docs.wefluence.app/llms.txt) | Peta docs yang ringkas | | [llms-full.txt](https://docs.wefluence.app/llms-full.txt) | Seluruh docs dalam satu berkas | | [openapi.yaml](https://docs.wefluence.app/openapi.yaml) | Kontrak API yang bisa dibaca mesin | | [openapi.json](https://docs.wefluence.app/openapi.json) | Kontrak yang sama dalam JSON | --- # Menjaga key tetap aman Key membuka data akunmu, jadi perlakukan seperti kata sandi. ## Yang perlu dilakukan - Simpan key di secret manager atau environment variable. - Pakai satu key untuk satu integrasi, supaya mudah dicabut tanpa mengganggu yang lain. - Beri scope sekecil yang dibutuhkan. Aktifkan `finance:read` hanya kalau memang perlu. - Panggil API dari server. API sengaja tidak bisa dipanggil dari browser, supaya key tidak terbaca pengunjung halaman. ## Yang jangan dilakukan - Jangan tulis key di kode, repositori, atau log. - Jangan tempel key ke chat, termasuk chat dengan asisten AI. - Jangan simpan key di dalam sel spreadsheet. ## Kalau key bocor Cabut secepatnya di **Pengaturan**, lalu **API key**, kemudian buat key baru. Key yang dicabut langsung berhenti bekerja. --- # Pengantar referensi Alamat, autentikasi, dan aturan yang berlaku di semua endpoint. Wefluence API memakai REST dan menjawab dalam JSON. Semua endpoint hanya membaca data. ```text https://api.wefluence.app/v1 ``` ## Endpoint | Metode | Path | Scope | | --- | --- | --- | | GET | [/v1/me](https://docs.wefluence.app/reference/account/) | Semua | | GET | [/v1/campaigns](https://docs.wefluence.app/reference/campaigns/) | `campaigns:read` | | GET | [/v1/campaigns/{id}](https://docs.wefluence.app/reference/campaigns/) | `campaigns:read` | | GET | [/v1/campaigns/{id}/stats](https://docs.wefluence.app/reference/campaign-stats/) | `campaigns:read` | | GET | [/v1/campaigns/{id}/content](https://docs.wefluence.app/reference/content/) | `content:read` | | GET | [/v1/campaigns/{id}/top-content](https://docs.wefluence.app/reference/content/) | `content:read` | | GET | [/v1/campaigns/{id}/creators](https://docs.wefluence.app/reference/creators/) | `content:read` | | GET | [/v1/campaigns/{id}/report](https://docs.wefluence.app/reference/reports/) | `content:read` | | GET | [/v1/reports/{token}](https://docs.wefluence.app/reference/reports/) | Tanpa key | | GET | [/v1/invoices](https://docs.wefluence.app/reference/invoices/) | `finance:read` | ## Aturan umum - Uang selalu rupiah bilangan bulat, waktu selalu UTC format ISO 8601. - Data yang tidak tersedia ditulis `null`, bukan 0. - Data milik akun lain dijawab `404`, sama seperti ID yang tidak ada. - Daftar memakai [cursor](https://docs.wefluence.app/pagination/), dan kena [batas pemakaian](https://docs.wefluence.app/rate-limits/). Kontrak lengkapnya ada di [openapi.yaml](https://docs.wefluence.app/openapi.yaml) (juga [openapi.json](https://docs.wefluence.app/openapi.json)), bisa langsung dibuka di Postman atau alat sejenis. --- # Akun Cek key, scope, dan pemakaian hari ini. ## Ambil info akun `GET /v1/me` Mengembalikan nama akun, scope key, dan pemakaian hari ini. Cocok untuk uji sambungan. Berlaku untuk semua key. ```bash curl https://api.wefluence.app/v1/me \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/me", headers=HEADERS).json() ``` ```javascript await (await fetch(`${API}/me`, { headers })).json(); ``` ```json { "object": "account", "brand": { "name": "Nama Brand" }, "key": { "label": "Dashboard marketing", "mode": "live", "scopes": ["campaigns:read", "content:read"], "expires_at": "2027-11-02T00:00:00.000Z" }, "quota": { "per_minute": 60, "per_day": 5000, "used_today": 1 } } ``` --- # Kampanye Daftar kampanye dan detailnya. ## Daftar kampanye `GET /v1/campaigns` Butuh scope `campaigns:read`. | Parameter | Tipe | Isi | | --- | --- | --- | | `status` | string | `draft`, `pending_review`, `active`, `budget_depleted`, `paused`, `ended`, `rejected`, atau `cancelled` | | `limit` | integer | Baris per halaman, 1 sampai 100, bawaan 50 | | `cursor` | string | `next_cursor` dari halaman sebelumnya | ```bash curl "https://api.wefluence.app/v1/campaigns?status=active" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/campaigns", headers=HEADERS, params={"status": "active"}).json() ``` ```javascript await (await fetch(`${API}/campaigns?status=active`, { headers })).json(); ``` ```json { "object": "list", "data": [ { "id": "abc123", "title": "Kampanye Oktober", "status": "active", "type": "clip_brand", "pricing": { "model": "per_views", "rate_per_1000_views": 5000 }, "budget": 5000000, "payment_status": "paid", "target_platforms": ["TikTok"], "deadline": "2026-11-30T16:59:59.000Z", "created_at": "2026-10-01T03:00:00.000Z" } ], "has_more": false, "next_cursor": null, "as_of": "2026-11-02T09:00:00.000Z" } ``` ## Detail kampanye `GET /v1/campaigns/{id}` Butuh scope `campaigns:read`. Isinya sama dengan baris di daftar, ditambah kolom berikut. | Kolom | Tipe | Isi | | --- | --- | --- | | `description` | string | Deskripsi kampanye | | `brief` | string | Brief untuk kreator | | `rules` | array | Aturan kampanye | | `approval` | string | `auto` atau `manual` | | `is_private` | boolean | Kampanye privat | | `reference_video` | string atau null | Link video contoh | ```bash curl https://api.wefluence.app/v1/campaigns/abc123 \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/campaigns/abc123", headers=HEADERS).json() ``` ```javascript await (await fetch(`${API}/campaigns/abc123`, { headers })).json(); ``` --- # Ringkasan kampanye Jumlah konten, views, engagement, dan biaya satu kampanye. ## Ambil ringkasan `GET /v1/campaigns/{id}/stats` Butuh scope `campaigns:read`. Blok `money` hanya keluar dengan `finance:read`. Ringkasan disimpan sampai 60 menit, atau 24 jam untuk kampanye yang sudah selesai. Jawaban membawa header `ETag`. Kirim lagi lewat `If-None-Match`, dan API menjawab `304` tanpa isi kalau belum ada perubahan. | Kolom | Isi | | --- | --- | | `applicants` | Jumlah pendaftaran | | `content` | Jumlah konten per status | | `views.verified_total` | Total views terverifikasi | | `views.by_platform` | Views per platform | | `engagement` | Total suka, komentar, shares, dan cakupannya | | `money` | Budget, sisa dana, nominal dibayar, dan biaya layanan | Baca [Arti angka](https://docs.wefluence.app/data/) sebelum memakai angkanya untuk laporan. ```bash curl https://api.wefluence.app/v1/campaigns/abc123/stats \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/campaigns/abc123/stats", headers=HEADERS).json() ``` ```javascript await (await fetch(`${API}/campaigns/abc123/stats`, { headers })).json(); ``` ```json { "object": "campaign_stats", "campaign_id": "abc123", "applicants": 195, "content": { "pending_review": 0, "in_admin_moderation": 0, "approved": 783, "rejected": 26 }, "views": { "verified_total": 1414148, "by_platform": { "tiktok": { "views": 1414148 } } }, "engagement": { "likes": 18014, "comments": 1224, "shares": 1693, "items_with_data": 587, "items_counted": 800 }, "money": { "currency": "IDR", "budget": 5000000, "remaining_budget": 0, "paid_to_creators": 5000000, "cost_per_1000_views": 3536, "platform_fee": 750000, "platform_fee_percent": 15 }, "as_of": "2026-11-02T09:00:00.000Z" } ``` --- # Konten Konten hasil kreator di satu kampanye. ## Daftar konten `GET /v1/campaigns/{id}/content` Butuh scope `content:read`. Konten yang masih diperiksa tim belum ikut, sama seperti di aplikasi. | Parameter | Tipe | Isi | | --- | --- | --- | | `status` | string | `pending_review`, `approved`, atau `rejected` | | `limit` | integer | Baris per halaman, 1 sampai 100, bawaan 50 | | `cursor` | string | `next_cursor` dari halaman sebelumnya | | Kolom | Isi | | --- | --- | | `id` | Tetap sama setiap kali ditarik, aman jadi kunci unik | | `creator.ref` | Tetap sama untuk kreator yang sama di akunmu | | `url` | Link konten | | `status` | Status konten | | `rejection_reason` | Alasan penolakan, hanya untuk konten ditolak | | `views.verified` | Views terverifikasi | | `views.flagged` | `true` kalau views ditandai bermasalah | | `engagement` | Suka, komentar, dan shares, atau `null` kalau belum dipindai | ```bash curl "https://api.wefluence.app/v1/campaigns/abc123/content?status=approved&limit=100" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get( f"{API}/campaigns/abc123/content", headers=HEADERS, params={"status": "approved", "limit": 100}, ).json() ``` ```javascript await (await fetch(`${API}/campaigns/abc123/content?status=approved&limit=100`, { headers })).json(); ``` ```json { "object": "list", "data": [ { "id": "cnt_8f3a1c9e42d70b15", "campaign_id": "abc123", "creator": { "ref": "crt_19ab77c0d2e4f611", "name": "Nama Kreator" }, "platform": "tiktok", "url": "https://www.tiktok.com/@contoh/video/123", "status": "approved", "submitted_at": "2026-10-20T03:12:00.000Z", "reviewed_at": "2026-10-21T08:40:00.000Z", "views": { "verified": 12500, "flagged": false }, "engagement": { "likes": 410, "comments": 22, "shares": 9, "scanned_at": "2026-10-27T02:00:00.000Z" } } ], "has_more": true, "next_cursor": "eyJhIjoi...", "as_of": "2026-11-02T09:00:00.000Z" } ``` ## Konten teratas `GET /v1/campaigns/{id}/top-content` Butuh scope `content:read`. Konten disetujui dengan views terbanyak, sudah terurut, tanpa perlu menarik semua halaman. Bentuk tiap barisnya sama dengan daftar konten. Datanya disimpan sampai 60 menit, lihat `as_of`. | Parameter | Tipe | Isi | | --- | --- | --- | | `limit` | integer | Jumlah baris, 1 sampai 100, bawaan 20 | | `platform` | string | `tiktok`, `instagram`, `youtube`, `facebook`, `threads`, `x`, atau `capcut` | | `min_views` | integer | Views minimal | Dengan `platform`, yang tersedia adalah 50 teratas platform itu. Untuk semua konten, pakai [Laporan](https://docs.wefluence.app/reference/reports/). ```bash curl "https://api.wefluence.app/v1/campaigns/abc123/top-content?platform=tiktok&limit=10" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get( f"{API}/campaigns/abc123/top-content", headers=HEADERS, params={"platform": "tiktok", "limit": 10}, ).json() ``` ```javascript await (await fetch(`${API}/campaigns/abc123/top-content?platform=tiktok&limit=10`, { headers })).json(); ``` --- # Kreator Kreator yang mendaftar ke satu kampanye. ## Daftar kreator `GET /v1/campaigns/{id}/creators` Butuh scope `content:read`. Satu baris untuk tiap pendaftaran. Nominal dibayar ada di sini karena pembayaran dicatat per pendaftaran, bukan per konten. | Parameter | Tipe | Isi | | --- | --- | --- | | `limit` | integer | Baris per halaman, 1 sampai 100, bawaan 50 | | `cursor` | string | `next_cursor` dari halaman sebelumnya | ```bash curl https://api.wefluence.app/v1/campaigns/abc123/creators \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/campaigns/abc123/creators", headers=HEADERS).json() ``` ```javascript await (await fetch(`${API}/campaigns/abc123/creators`, { headers })).json(); ``` ```json { "object": "list", "data": [ { "ref": "crt_19ab77c0d2e4f611", "name": "Nama Kreator", "joined_at": "2026-10-02T04:00:00.000Z", "approved_content": 3, "verified_views": 41200, "paid_amount": 206000 } ], "has_more": false, "next_cursor": null, "as_of": "2026-11-02T09:00:00.000Z" } ``` --- # Laporan File Excel atau CSV satu kampanye, dibuat di server dan diunduh lewat link. ## Buat laporan `GET /v1/campaigns/{id}/report` Butuh scope `content:read`. Server menyusun file lengkap satu kampanye, lalu menjawab dengan link unduhan. Isinya tidak ikut di jawaban, jadi cocok untuk kampanye dengan ribuan konten dan untuk asisten AI. | Parameter | Tipe | Isi | | --- | --- | --- | | `format` | string | `xlsx` atau `csv`, bawaan `xlsx` | | `status` | string | `approved`, `pending_review`, `rejected`, atau `all`, bawaan `approved` | | Kolom | Isi | | --- | --- | | `url` | Link unduhan, berlaku 24 jam | | `expires_at` | Waktu link berakhir | | `rows` | Jumlah konten di file | | `truncated` | `true` kalau konten melebihi 20.000 baris, yang masuk file adalah yang views-nya terbanyak | | `reused` | `true` kalau memakai file yang dibuat kurang dari 60 menit lalu | ```bash curl "https://api.wefluence.app/v1/campaigns/abc123/report?format=xlsx" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python report = requests.get( f"{API}/campaigns/abc123/report", headers=HEADERS, params={"format": "xlsx"}, ).json() file = requests.get(report["url"]) open(report["file_name"], "wb").write(file.content) ``` ```javascript const report = await (await fetch(`${API}/campaigns/abc123/report?format=xlsx`, { headers })).json(); const file = await fetch(report.url); ``` ```json { "object": "report", "campaign_id": "abc123", "format": "xlsx", "status": "approved", "rows": 1248, "truncated": false, "file_name": "kampanye-oktober.xlsx", "url": "https://api.wefluence.app/v1/reports/rpt_Zk3v...", "expires_at": "2026-11-04T09:00:00.000Z", "reused": false } ``` ## Unduh file `GET /v1/reports/{token}` Tidak butuh key, jadi link bisa dibuka langsung di browser atau diberikan asisten AI kepadamu. Perlakukan link seperti file itu sendiri: siapa pun yang memegangnya bisa mengunduh sampai `expires_at`. Link mati lebih awal kalau key pembuatnya dicabut. ## Isi file Excel | Lembar | Isi | Tersedia untuk | | --- | --- | --- | | Ringkasan | Total views, interaksi, engagement rate, jumlah kreator, rincian platform | Semua key | | Konten teratas | Setiap konten dengan views, suka, komentar, bagikan, waktu pindai, status, dan link | Semua key | | Performa kreator | Views, interaksi, engagement, jumlah konten, dan kontribusi tiap kreator | Semua key | | Performa kampanye | Budget, sisa budget, status, dan tenggat | `finance:read` | Dengan `finance:read`, lembar Ringkasan juga memuat budget, dibayar ke kreator, sisa budget, dan biaya per 1.000 views, sedangkan Performa kreator memuat pendapatan tiap kreator. ## Isi file CSV Satu baris untuk tiap konten, dalam UTF-8. Nama kolomnya sama dengan API supaya mudah dipetakan: `id`, `creator_name`, `creator_ref`, `platform`, `url`, `status`, `views`, `views_flagged`, `likes`, `comments`, `shares`, `scanned_at`, `submitted_at`, `reviewed_at` ## Batas Satu key bisa membuat 30 laporan per hari. Permintaan yang sama dalam 60 menit memakai file yang sudah ada dan tidak dihitung lagi. --- # Tagihan Tagihan akunmu dan statusnya. ## Daftar tagihan `GET /v1/invoices` Butuh scope `finance:read`. | Parameter | Tipe | Isi | | --- | --- | --- | | `status` | string | `unpaid`, `claimed` (transfer sedang dicek), `paid`, atau `void` | | `limit` | integer | Baris per halaman, 1 sampai 100, bawaan 50 | | `cursor` | string | `next_cursor` dari halaman sebelumnya | ```bash curl "https://api.wefluence.app/v1/invoices?status=paid" \ -H "Authorization: Bearer $WEFLUENCE_API_KEY" ``` ```python requests.get(f"{API}/invoices", headers=HEADERS, params={"status": "paid"}).json() ``` ```javascript await (await fetch(`${API}/invoices?status=paid`, { headers })).json(); ``` ```json { "object": "list", "data": [ { "id": "inv123", "number": "INV/WF/2026/0001", "kind": "campaign", "status": "paid", "subject": "kampanye Kampanye Oktober", "campaign_id": "abc123", "lines": [ { "label": "Saldo kampanye (reward kreator)", "amount": 5000000 }, { "label": "Service & Protection Fee (15%)", "amount": 750000 } ], "fee_percent": 15, "total": 5750000, "received_amount": 5750000, "created_at": "2026-11-02T03:00:00.000Z", "due_at": "2026-11-09T03:00:00.000Z", "paid_at": "2026-11-02T06:00:00.000Z", "wallet_paid_at": null, "receipt_number": "KWT/WF/2026/0001" } ], "has_more": false, "next_cursor": null, "as_of": "2026-11-02T09:00:00.000Z" } ``` --- # Server MCP Alat baca untuk asisten AI, dengan key dan batas yang sama dengan API. ## Sambungan `POST /v1/mcp` Streamable HTTP tanpa sesi, dengan header `Authorization: Bearer`. Key, scope, dan batas sama dengan API. Hanya panggilan alat yang memakai kuota harian. Cara memasangnya ada di [Asisten AI](https://docs.wefluence.app/guides/ai-assistants/). ```json { "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "list_content", "arguments": { "campaign_id": "abc123", "status": "approved", "limit": 20 } } } ``` ## Daftar alat Semua alat hanya membaca data. Alat yang di luar scope key tidak muncul. | Alat | Scope | Isi | | --- | --- | --- | | `get_account` | Semua | Nama akun, scope key, dan pemakaian hari ini | | `list_campaigns` | `campaigns:read` | Daftar kampanye | | `get_campaign` | `campaigns:read` | Detail kampanye | | `get_campaign_stats` | `campaigns:read` | Ringkasan konten, views, dan engagement | | `get_top_content` | `content:read` | Konten dengan views terbanyak | | `create_campaign_report` | `content:read` | File Excel atau CSV, asisten hanya menerima link | | `list_content` | `content:read` | Konten satu kampanye, per halaman | | `list_creators` | `content:read` | Kreator satu kampanye | | `list_invoices` | `finance:read` | Tagihan | ## Hemat percakapan Asisten AI membayar setiap baris yang dibacanya. Untuk kampanye besar, `get_campaign_stats` dan `get_top_content` cukup untuk menjawab pertanyaan, dan `create_campaign_report` untuk data lengkap. `list_content` paling cocok kalau butuh beberapa baris saja. Alat `create_campaign_report` menghasilkan [link unduhan](https://docs.wefluence.app/reference/reports/) yang bisa dibuka siapa pun yang memegangnya, jadi jangan tempel di tempat umum.