Aksita.ai Logo Dokumentasi

Autentikasi

API Publik Aksita.ai mengandalkan API Keys untuk autentikasi request. Key ini secara unik mengidentifikasi agent Anda dan mengontrol format response untuk berbagai platform. Anda dapat membuat beberapa API Key per agent, masing-masing dengan format response sendiri (Markdown, WhatsApp, Custom Platform, dll.). Kelola API Key Anda langsung dari dashboard di tab API Keys.

Beberapa API Key Per Agent

Anda dapat membuat beberapa API key untuk agent yang sama, masing-masing dengan format response berbeda. Misalnya: satu key untuk integrasi WhatsApp dengan format yang dioptimalkan WhatsApp, satu lagi untuk Discord dengan format khusus Discord, dan yang ketiga untuk aplikasi mobile Anda dengan Markdown standar.

Praktik Keamanan Terbaik

API Key Anda memiliki hak akses yang signifikan. Perlakukan seperti password: jaga kerahasiaan dan keamanannya. Jangan pernah membagikan API key Anda di area yang dapat diakses publik seperti repository GitHub, kode client-side, atau forum publik.

Mengelola API Keys

Untuk membuat dan mengelola API keys:

  1. Buka dashboard agent Anda
  2. Klik tab API Keys di sidebar
  3. Klik Create API Key
  4. Masukkan nama (misalnya, "WhatsApp Bot", "Integrasi Discord")
  5. Pilih format response:
    • Markdown - Format markdown standar (default)
    • WhatsApp - Dioptimalkan untuk pesan WhatsApp
    • Custom Platform - Tentukan nama platform (misalnya, Discord, Telegram)
    • Custom Example - Berikan contoh pesan chat untuk memandu format
  6. Salin API key yang dihasilkan segera (Anda tidak akan melihatnya lagi!)

Penting: Simpan API Key Anda

Setelah membuat API key, pastikan untuk menyalin dan menyimpannya segera. Untuk alasan keamanan, API key lengkap hanya ditampilkan sekali saat pembuatan. Jika Anda kehilangan, Anda perlu membuat yang baru.

Format Header

Autentikasi dilakukan melalui HTTP headers. Sertakan API key unik Anda di header <code>X-API-Key</code> pada setiap request yang Anda buat.

X-API-Key: api_key_anda

Autentikasi Gagal

Jika API key Anda hilang, tidak valid, atau telah dicabut, API akan mengembalikan response <code>401 Unauthorized</code>.

401 Unauthorized
{
  "status": false,
  "reason": "API Key Tidak Valid"
}