AgencyHandy API: Autentikasi dan Memulai

API AgencyHandy memungkinkan Anda mengotomatiskan pembuatan lead, manajemen klien, pembaruan pesanan, dan banyak lagi dari sistem atau skrip eksternal mana pun. Setiap permintaan diautentikasi dengan API key yang Anda buat dari pengaturan workspace. Panduan ini memandu Anda mendapatkan kredensial dan melakukan panggilan API pertama Anda.

Anda harus menjadi SuperAdmin atau Admin di workspace AgencyHandy Anda untuk membuat API key.

URL Dasar

Semua permintaan API dibuat ke:

https://api.agencyhandy.com

Ganti {{URL}} dengan URL dasar ini di semua contoh permintaan di seluruh dokumentasi API.

Langkah 1: Buat API key

Buka Workspace Configuration

Navigasi ke pengaturan workspace Anda di:

{{workspaceUrl}}/workspace-config?tab=api-key

Ini membuka tab API Key di dalam Workspace Configuration.

Buat dan salin API key Anda

Klik Generate (atau Regenerate jika key sudah ada). Salin API key dan simpan dengan aman — perlakukan seperti kata sandi. AgencyHandy tidak akan menampilkannya lagi setelah Anda meninggalkan halaman.

Membuat ulang API key Anda segera membatalkan key sebelumnya. Integrasi yang ada menggunakan key lama akan berhenti berfungsi sampai Anda memperbaruinya dengan key baru.

Langkah 2: Ambil Company ID Anda

Sebagian besar endpoint API memerlukan header companyid yang mengidentifikasi workspace mana yang menjadi target permintaan. Gunakan endpoint berikut untuk mengambil Company ID Anda.

Endpoint

GET {{URL}}/accounts/companies

Header	Nilai
`x-api-key`	API key Anda

Contoh permintaan

cURL

curl --request GET "https://api.agencyhandy.com/accounts/companies" \
  --header "x-api-key: <YOUR_API_KEY>"

Contoh respons

{
  "message": "Companies associated with API token.",
  "companies": [
    {
      "_id": "6525994184e9ddd79853450e",
      "name": "onethread123",
      "logo": "",
      "extraSmallLogo": "",
      "largeLogo": ""
    }
  ]
}

Temukan Company ID Anda

Dalam respons, temukan kolom _id di dalam array companies. Ini adalah Company ID Anda.

const companyId = response.companies[0]._id;
// e.g. "6525994184e9ddd79853450e"

Simpan Company ID

Simpan Company ID untuk digunakan di semua permintaan API berikutnya. Anda akan meneruskannya sebagai header companyid:

Header	Nilai
`x-api-key`	API key Anda
`companyid`	Company ID Anda

Ringkasan autentikasi

Setiap permintaan API yang terautentikasi memerlukan minimal:

x-api-key: <YOUR_API_KEY>
companyid: <YOUR_COMPANY_ID>

Dengan API key dan Company ID di tangan, Anda siap menggunakan sisa API AgencyHandy. Lanjutkan ke salah satu panduan endpoint di bawah ini.

Pengantar

Endpoints

AgencyHandy API: Autentikasi dan Memulai

URL Dasar

Langkah 1: Buat API key

Langkah 2: Ambil Company ID Anda

Endpoint

Header

Contoh permintaan

Contoh respons

Ringkasan autentikasi

​URL Dasar

​Langkah 1: Buat API key

​Langkah 2: Ambil Company ID Anda

​Endpoint

​Header

​Contoh permintaan

​Contoh respons

​Ringkasan autentikasi

URL Dasar

Langkah 1: Buat API key

Langkah 2: Ambil Company ID Anda

Endpoint

Header

Contoh permintaan

Contoh respons

Ringkasan autentikasi