סקירה כללית

סקירה כללית #

ה-API יכול לשמש לניהול תכונות בחשבון שלך. המידע למטה מפרט את הפורמט שבו משתמשים בבקשות ותגובות API.

מיקומי משאבים ובסיס URL #

בהתאם לאזור שבו ~.Dimensions.~ ממוקם ומופע ה-DIXX ישנן כתובות URL שונות לגישה למשאבי ה-API. אנא השתמש בטבלה למטה כדי למצוא את הבסיס הנכון URL לאזור שלך.

אזור בסיס URL
אוסטרליה / ניו זילנד https://api.au.myreports.cloud
אירופה https://api.eu.myreports.cloud
צפון אמריקה https://api.na.myreports.cloud
הממלכה המאוחדת https://api.uk.myreports.cloud

לאחר שזיהית את הבסיס URL עבור האזור שלך, הפורמט לכל בקשות API מוצג להלן:

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

למשל,

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

API אינטראקציה #

ה-API דורש שימוש בהגדרות פורמט JSON לתוכן כל בקשה. כל תגובה תוחזר בפורמט JSON באמצעות התבנית הבאה:

 
{ 
	"data": {
		<returned data>
	}, 
	"שגיאה": <errorCode>, 
	"הודעה": <message>, 
	"סטטוס": <status>, 
	"חותמת זמן": <timestamp UTC>
}
Hand Left warning
חלק מהשדות לא תמיד יוחזרו

אם ה-data שמוחזר הוא אוסף, הוא יחזיר מערך בגודל הדף.

 
{ 
	"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",
		}
	], 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "<timestamp in UTC>"
}

API משאבים #

הטבלה הבאה מספקת מתווה של המשאבים ש-API מספק גישה אליהם:

משאב תיאור
מדריכים חפש תיקיות ונהל פריטי תיקיות בודדים.
מרחבי עבודה שאילתא סביבות עבודה מוגדרות, שאילתא והרץ דוחות מוגדרים.

כל משאב מספק את הממשקים הבאים לאינטראקציה:

ממשק תיאור
Get All מחזיר אוסף של כל הפריטים התואמים לסוג המשאב.
קח... מחזיר מופע מסוים של סוג המשאב.
ליצור... יוצר מופע חדש של סוג משאב.
פאץ'... מעדכן מופע קיים של סוג משאב.
מחק... מסיר מופע קיים של סוג משאב.