Ikhtisar #

Itu API dapat digunakan untuk mengelola properti di akun Anda. Informasi di bawah ini menguraikan format yang digunakan untuk API permintaan dan tanggapan.

Lokasi Sumber Daya & Basis 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 setiap API permintaan ditunjukkan di bawah ini:

{BASE_URL}/api/{VERSI}/{SUMBER DAYA}

misalnya

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

API Interaksi #

Itu API membutuhkan penggunaan JSON definisi format untuk konten permintaan apa pun. Setiap tanggapan akan dikembalikan di JSON format menggunakan template berikut:

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

warning
Beberapa bidang mungkin tidak selalu dikembalikan

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": "berhasil",
	"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: