API Sociovite

API Sociovite memungkinkan klien yang terautentikasi membuat proyek pemantauan, mengumpulkan mentions di media sosial, memeriksa kuota, dan menghasilkan ringkasan dengan AI.

Dokumentasi ini mengikuti Sociovite Swagger 2.0, API versi 1.2. Dokumentasi ini menambahkan panduan berorientasi tugas dan alur aplikasi tanpa menciptakan endpoint yang tidak tercantum dalam kontrak tersebut.

Yang dapat Anda lakukan

Kemampuan	Endpoint
Masuk dan mengelola sesi	/api/auth/*
Membuat, melihat daftar, mengubah status pemantauan, dan menghapus proyek	/api/project*
Memulai scraping kata kunci	/api/ai-service/scrap-project-keywords
Membaca mentions yang telah dikumpulkan	/api/mentions
Menghasilkan dan mengambil ringkasan AI	/api/project/*summary*
Memeriksa kuota pengguna yang terautentikasi	/api/user-quota

Autentikasi

Sebagian besar endpoint menggunakan bearer access token:

Authorization: Bearer <access_token>

Mulailah dengan memanggil POST /api/auth/login. Responsnya berisi token; gunakan nilai tersebut sebagai bearer token untuk endpoint yang dilindungi.

curl -X POST \
  "$SOCIOVITE_API_URL/api/auth/login" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "your_username",
    "password": "your_password"
  }'

Lihat API Autentikasi untuk detail login, pembaruan token, validasi sesi, dan logout.

Istilah pengenal

Dalam dokumentasi ini:

• ID proyek adalah data.id yang dikembalikan saat endpoint proyek meminta id.
• ID kata kunci adalah nilai yang diminta oleh field bernama keywordID, keywordId, atau keyword_id.
• Nama parameter dipertahankan persis seperti yang ditetapkan oleh API karena perbedaan huruf besar dan kecil berpengaruh.

Alur aplikasi yang tersedia mengasumsikan bahwa data.id juga merupakan ID kata kunci yang digunakan untuk scraping, mentions, dan ringkasan. Konfirmasikan asumsi ini jika backend yang digunakan menyediakan pengenal kata kunci terpisah. Sebagai contoh, endpoint mentions memerlukan keywordId, sedangkan body permintaan scraping memerlukan keyword_id.

Alur permintaan umum

1. Login dan simpan bearer token.
2. Periksa kuota jika diperlukan.
3. Buat proyek dan simpan data.id.
4. Mulai scraping menggunakan ID tersebut.
5. Ambil mentions menggunakan ID tersebut sebagai keywordId.
6. Buat dan ambil ringkasan.
7. Logout dari sesi saat ini atau dari semua perangkat.

Lanjutkan ke Alur aplikasi untuk panduan setiap endpoint secara berurutan.