Ikhtisar #

API dapat digunakan untuk menyediakan pelanggan dan mengelola pengguna dan PBX Koneksi. Informasi di bawah ini menguraikan format yang digunakan untuk API permintaan dan tanggapan.

Lokasi Sumber Daya & Dasar URL #

Tergantung pada wilayah Anda ~.Dimensions.~ instance terletak di, ada URL yang berbeda untuk mengakses sumber daya api. Silakan gunakan tabel di bawah ini untuk menemukan basis yang benar URL untuk wilayah Anda.

Setelah Anda mengidentifikasi basis URL untuk wilayah Anda, format untuk API Permintaan ditunjukkan di bawah ini:

{BASE_URL}/api/{VERSION}/{RESOURCE}

misalnya

https://api.na.myreports.cloud/api/v1.0/customers

API Interaksi #

API memerlukan penggunaan definisi format Json untuk konten permintaan apa pun. Setiap respons akan dikembalikan dalam format Json menggunakan templat berikut:

{
	"data": {
		<returned data>
	},
	"kesalahan": <errorCode>,
	"pesan": <message>,
	"status": <status>,
	"Stempel waktu": <timestamp UTC>
}

warning
Beberapa kolom mungkin tidak selalu ditampilkan

Jika data returned adalah koleksi, itu akan mengembalikan array dengan ukuran halaman.

{
	"page_size": "<number of items>",
	"data": [ {
			"id": "90ce2cce-5b90-424b-b502-55924f140a48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	][{
			"id": "90ce2cce-5b90-424b-b502-55924f140a48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	],
	"status": "sukses",
	"stempel waktu": "<timestamp in UTC>"
}

API Sumber daya #

Tabel berikut memberikan garis besar sumber daya API menyediakan akses ke:

Setiap sumber daya menyediakan antarmuka berikut untuk interaksi: