API תיעוד

השירות EnergyFather עוזר לקנות (לשכור) את האנרגיה ורוחב הפס הדרושים לשליחת עסקאות ואסימונים USDT קריפטוגרפיים אחרים TRC20; רוחב פס נדרש גם כדי לשלוח כל סוג של עסקה בבלוקצ'יין, כגון שליחה TRON TRX, תביעת תגמולים והצבעה עבור Super Representatives .

הליך קניית אנרגיה

כדי לקנות אנרגיה, עליך להירשם לשירות EnergyFather, לתפוס את אסימון ההרשאה מהדף "אסימונים > API הקונה", ולמלא את יתרת חשבון הקונה.

לאחר יצירת הזמנה (שיטה ‘buy/energy’) אנרגיה יכולה להיות מועברת עם עיכוב של מספר שניות או אפילו דקות, ולכן בעת פיתוח מערכות אוטומטיות מומלץ לבדוק מעת לעת את ביצוע ההזמנה על ידי בקשת שיטה ‘order/get/{guid}’ .

לדוגמה, אם אתה מתכנן לשלוח USDT וברצונך להוזיל עסקאות על ידי רכישת אנרגיה, אתה עושה את הפעולות הבאות:

  • בקש את השיטה להעריך את ‘buy/energy’ כמות האנרגיה הדרושה וקנה אותה,
  • בקש ‘order/get/{guid}’ מעת לעת שיטה עד להאצלת אנרגיה (בדרך כלל זה לוקח כמה שניות),
  • שלח USDT (האנרגיה שנרכשה תשמש לתשלום דמי העסקה).

הערות כלליות

בתיעוד זה, ביטוי עטוף בסוגריים מסולסלים כמו ‘{guid}’ או ‘{id}’ פירושו הערך של המשתנה המתאים:

  • ‘{guid}’ הוא המזהה הייחודי הכללי של האובייקט ב EnergyFather- (בדרך כלל 8 ספרות),
  • ‘{id}’ הוא המספר הרציף של האובייקט עבור משתמש זה (המספור מתחיל ב ‘1’- עבור כל משתמש).

API נקודת קצה

https://panel.energyfather.com/api/v1/private

שלח בקשות באמצעות השיטה POST.

אישור בקשות

כדי לאשר (לאשר) בקשות לפרטי API, HTTP יש להעביר כותרת:

Token: {token}

ניהול אסימוני הרשאה ממוקם בלוח הבקרה, בדף "קונה > API אסימונים".

לדוגמה, באפשרותך לקבל מידע אודות הזמנת 123456 באופן הבא:

CURL -X POST 'https://panel.energyfather.com/api/v1/private/order/get/123456' 
-H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

סטטוס הזמנה

  • "0" -ממתינים. הסדר נוצר זה עתה.
  • "1" - ממתין לתשלום. קישור התשלום כבר נוצר, EnergyFather ממתין להתקשרות חוזרת ממערכת התשלומים. מצב זה אינו משמש אם ההזמנה משולמת כולה על ידי כספים הזמינים בחשבון הפנימי.
  • "2" - הליך האצלת האנרגיה נמשך.
  • "3" - מואצל. אנרגיה ניתנת החוצה.
  • "4" - הוחזר (ללא האצלה). האנרגיה מושכת עקב תום תקופת הזמן בתשלום.
  • "5" -שילם. ההזמנה משולמת ומתווספת לתור לאספקת אנרגיה.
  • "6" -שגיאה.

רצף הסטטוסים הרגיל: 0, 5, 2, 3, 4 .

API שיטות
  • /api/v1/private/buy/energy – לקנות אנרגיה (משולם מחשבון פנימי)
  • /api/v1/private/order/list – קבל רשימה של ההזמנות שלך
  • /api/v1/private/order/get/{guid} – קבל מידע על ההזמנה שלך
  • /api/v1/private/account/list – קבל רשימה של החשבונות הפנימיים שלך
  • /api/v1/private/account/get/{id} – קבל מידע על החשבון הפנימי שלך

השיטה "buy/energy" – לקנות אנרגיה (משולמת מחשבון פנימי)

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

אם לחשבון הפנימי אין מספיק כספים, ההזמנה תיווצר ותקבל מיד סטטוס "6" (שגיאה). במקרה זה אתה צריך לבקר את הפאנל, להפקיד כמה כספים ולאחר מכן לשלוח בקשה חדשה API לקנות אנרגיה.

ישנן שתי דרכים להגדיר את כמות האנרגיה שיש לרכוש:

א) אתה יכול להגדיר את כמות האנרגיה המדויקת "amount" בפרמטר, אז אתה צריך גם להגדיר amount_source="amount" .

ב) אם אינך יודע כמה אנרגיה נדרשת לעסקה לשלוח USDT או אסימון אחר, תוכל להגדיר amount_source="estimate" ולמלא את הפרמטרים המתאימים (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy בקשה לדוגמה עם כמות מדויקת של אנרגיה:

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/buy/energy' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS' 
  -d '{
    "format": "json",
    "to":     "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
    "amount_source": "amount", 
    "amount": 31895,
    "period_type": "days",
    "period_amount": 3
}'

buy/energy בקשה לדוגמה עם חישוב כמות האנרגיה הדרושה

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/buy/energy' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS' 
  -d '{
    "format": "json",
    "to":     "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
    "amount_source": "estimate", 
    "estimate_to": "TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH,TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo",
    "estimate_token": "USDT",
    "estimate_adjust_percent": 0.04,
    "period_type": "days",
    "period_amount": 3
}'

buy/energy בקש פרמות:

  • to (מחרוזת, חובה) – TRON כתובת שאליה יש להאציל את האנרגיה
  • period_amount (מספר שלם, חובה) – פרק זמן לקניית אנרגיה
  • period_type (מחרוזת, חובה) – סוג פרק הזמן. ערכים אפשריים: days, hours .
  • format (מחרוזת, אופציונלי) – פורמט תגובה. ערכים אפשריים: json (default), xml .
  • amount_source (מחרוזת, חובה) – אלגוריתם לקביעת כמות האנרגיה המואצלת. אם הערך הוא "amount", נעשה שימוש בערך הפרמטר "amount". אם הערך הוא "estimate", כמות האנרגיה הנדרשת מחושבת על בסיס הפרמטרים estimate_to, estimate_token, estimate_adjust_percent . ערכים אפשריים: amount, estimate .
  • amount (מספר שלם, נדרש אם amount_source="amount" ) – כמות האנרגיה שיש לרכוש. מתעלמים ממנו אם amount_source="estimate" .
  • estimate_to (מחרוזת, נדרשת אם amount_source="estimate" ) – רשימת כתובות המופרדות באמצעות פסיקים שאליהן TRON מתוכננות להישלח עסקאות אסימונים
  • estimate_token (מחרוזת, נדרש אם amount_source="estimate" ) – האסימון TRC20. ערכים אפשריים (תלויי רישיות): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX .
  • estimate_adjust_percent (עשרוני, נדרש אם amount_source="estimate" ) – כמות האנרגיה העודפת המבוטאת באחוזים. עודף זה נחוץ כדי למנוע שריפה TRX, אשר עשוי לקרות אם הכתובת יש בדיוק את כמות האנרגיה הדרושה. הערך המומלץ הוא 0.04%.

חשוב: נכון לעכשיו, רק 6 תקופות תקפות: 1 hour ו 1, 3, 7, 15, 30 days- .

buy/energy:תגובה

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

{
	"status": "ok",
	"data": {
		"guid": 81373165,
		"estimate_task_id": null,
		"status": 0,
		"order_cost": "6.051",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": 61000,
		"period_type": "hours",
		"energy_delegation_fee": "0.561000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"estimate_task": null
	},
	"balance": "7.29412"
}

אם הבקשה מכילה amount_source="estimate" אז לתגובה יש סעיף "estimate_task" נוסף . לדוגמה:

{
	"status": "ok",
	"data": {
		"guid": 77082757,
		"estimate_task_id": 42708906,
		"status": 0,
		"order_cost": "0.561",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": null,
		"period_type": "hours",
		"energy_delegation_fee": "0.561000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"estimate_task": {
			"id": 42708906,
			"token": "USDT",
			"currency": "USD",
			"from": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
			"to": [
				"TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH",
				"TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo"
			]
		}
	},
	"balance": "18.29412"
}

buy/energy פרמות תגובה:

  • guid – הצו GUID
  • balance – כספים הזמינים כעת בחשבון הפנימי, TRX
  • days – משך אספקת האנרגיה בימים, אם "period_type=days"
  • hours – משך אספקת האנרגיה בשעות, אם "period_type=hours"
  • estimate_task – חישוב (הערכה) של האנרגיה הדרושה לשליחת TRC20 עסקאות מכתובת אחת TRON לרשימת כתובות אחרות TRON

השיטה "order/get/{guid}" – קבלת פרטי ההזמנה

קבלת מידע על ההזמנה הספציפית.

order/get/{guid} – בקשה לדוגמה

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/order/get/12345' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

order/get/{guid} – תגובה לדוגמה

{
	"status": "ok",
	"data": {
		"guid": 81373165,
		"estimate_task_id": 32301594,
		"status": 3,
		"payment_status": 0,
		"order_cost_paid": "4.146350000000000000",
		"order_cost": "4.146350000000000000",
		"to": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
		"energy_amount": 31895,
		"period_type": "hours",
		"energy_delegation_fee": "0.000000000000000000",
		"address_activation_fee": "0.000000000000000000",
		"hours": 1,
		"days": 0,
		"resource_txs": [
			{
				"order_guid": 81373165,
				"delegate_txid": "961b6fbd7cc2090d1a65abc06bfabde1046e02d35394f6eca8d05812a6e3ab7"
			}
		],
		"estimate_task": {
			"id": 42708906,
			"token": "USDT",
			"currency": "USD",
			"from": "TQHAAJWLLEjBgYq2sjUnq4kbKfajEXEvyE",
			"to": [
				"TLVkYEp4Ue2RpK5v1XNZAB3769g44BSZyH",
				"TJm6HiCMVZdBHbNHThdMv1RambstJPrfYo"
			]
		}
	}
}

order/get/{guid} – פרמות תגובה

  • guid – הצו GUID
  • balance – כספים הזמינים כעת בחשבון הפנימי, TRX
  • days – משך אספקת האנרגיה בימים, אם "period_type=days"
  • hours – משך אספקת האנרגיה בשעות, אם "period_type=hours"
  • to – TRX כתובת שבה האנרגיה מועברת
  • energy_amount – כמות אנרגיה
  • order_cost – עלות הזמנה, TRX
  • order_cost_paid – סכום שכבר שולם, TRX (במקרה של חוסר מספיק כספים בחשבון הפנימי סכום זה יהיה פחות מ "order_cost" )
  • address_activation_fee – סכום התשלום עבור הפעלת כתובת היעד, TRX
  • energy_delegation_fee – תשלום עבור גודל הזמנה קטן מדי, TRX
  • resource_txs – מערך המכיל את רשימת העסקאות בבלוקצ'יין TRON שבהן משאבים מוקצים ומוחזרים (ללא הקצאה)
  • status – מצב הזמנה, ערכים אפשריים מתוארים בתחילת מדריך זה
  • payment_status – סדר סטטוס תשלום במערכת התשלומים (ערכים אפשריים תלויים במערכת התשלומים)

השיטה "order/list" – קבלת רשימת ההזמנות

קבלת רשימת ההזמנות.

order/list – בקשה לדוגמה

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/order/list' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

order/list – בקש פרמטרים

  • sort (מחרוזת, אופציונלי) – מיון ערכים, כברירת מחדל "created_at|desc"
  • per_page (מספר שלם, אופציונלי) – הגבל את מספר הערכים לתגובה
  • page (מספר שלם, אופציונלי) – מספר רציף של דף התגובה
  • filter (מערך של arrays(objects), אופציונלי) – מסנן ערכים

order/list – תגובה לדוגמה

{
	"current_page": 1,
	"data": [
		{
			"guid": 96134274,
			"status": 4
		},
		{
			"guid": 81373165,
			"status": 3
		}
	],
	"first_page_url": "/api/v1/private/order/list?page=1",
	"from": 1,
	"last_page": 1,
	"last_page_url": "/api/v1/private/order/list?page=1",
	"links": [
		{
			"url": null,
			"label": "pagination.previous",
			"active": false
		},
		{
			"url": "/api/v1/private/order/list?page=1",
			"label": "1",
			"active": true
		},
		{
			"url": null,
			"label": "pagination.next",
			"active": false
		}
	],
	"next_page_url": null,
	"path": "/api/v1/private/order/list",
	"per_page": 15,
	"prev_page_url": null,
	"to": 2,
	"total": 2,
	"draw": null,
	"status": "ok"
}

order/list – פרמות תגובה

  • guid – GUID של הסדר
  • status – סטטוס התגובה API

השיטה "account/list" – רישום חשבונות פנימיים

קבלת רשימה של חשבונות פנימיים, כולל כמות הכספים הזמינים כעת. מכיוון שיש חשבון פנימי נפרד לכל חלק באתר (buyer, affiliate, seller, dealer), ישנם חשבונות מרובים בחשבון.

account/list – בקשה לדוגמה

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/account/list' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

account/list – תגובה לדוגמה

{
	"current_page": 1,
	"data": [
		{
			"guid": 29778748,
			"user_id": 81841325,
			"id": 1,
			"section": "affiliate",
			"currency": "TRX",
			"balance": "2.511531"
		},
		{
			"guid": 64463815,
			"user_id": 81841325,
			"id": 2,
			"section": "buyer",
			"currency": "TRX",
			"balance": "41.704"
		}
	],
	"first_page_url": "/api/v1/private/account/list?page=1",
	"from": 1,
	"last_page": 1,
	"last_page_url": "/api/v1/private/account/list?page=1",
	"links": [
		{
			"url": null,
			"label": "pagination.previous",
			"active": false
		},
		{
			"url": "/api/v1/private/account/list?page=1",
			"label": "1",
			"active": true
		},
		{
			"url": null,
			"label": "pagination.next",
			"active": false
		}
	],
	"next_page_url": null,
	"path": "/api/v1/private/account/list",
	"per_page": 15,
	"prev_page_url": null,
	"to": 2,
	"total": 2,
	"draw": null,
	"status": "ok"
}

account/list – פרמות תגובה

  • guid – GUID של החשבון הפנימי
  • id – רצף ID של החשבון הפנימי
  • section – לאיזה EnergyFather סעיף שייך האיזון הזה
  • balance – כספים זמינים
  • currency –מטבע
  • user_id – GUID של המשתמש

השיטה "account/get/{id}" – קבלת החשבון הפנימי המדויק

קבלת יתרת החשבון הפנימי עבור סעיף מסוים של EnergyFather . מאז כל סעיף יש חשבון (buyer, affiliate, seller, dealer) משלו, ישנם מספר חשבונות עבור כל משתמש. תחילה תוכל להשתמש בשיטה כדי לקבל את "account/list" הרשימה שלהם, לברר את ‘id’ חשבון הריבית ולאחר מכן להשתמש בשיטה זו ‘id’ כדי לקבל את יתרת החשבון המסוים.

account/get/{id} – בקשה לדוגמה

curl -X 'POST' 
  'https://panel.energyfather.com/api/v1/private/account/get/1' 
  -H 'Token: 123456xxxxxxxxxxxxxxxxxxxxxxNOPQRS'

account/get/{id} – תגובה לדוגמה

{
	"status": "ok",
	"data": {
		"guid": 64463815,
		"user_id": 81841325,
		"id": 2,
		"section": "buyer",
		"currency": "TRX",
		"balance": "41.704"
	}
}

account/get/{id} – פרמות תגובה

  • guid – GUID של החשבון הפנימי
  • id - מזהה רציף של החשבון הפנימי
  • section - לאיזה EnergyFather סעיף שייכת יתרה זו
  • balance - כספים זמינים
  • currency -מטבע
  • user_id - GUID של המשתמש