dogfennaeth API

Gweithdrefn prynu ynni

I brynu ynni, mae angen i chi gofrestru yn y gwasanaeth EnergyFather, bachu'r tocyn awdurdodi o'r dudalen "Prynwr > tocynnau API", ac ychwanegu at gydbwysedd cyfrif y Prynwr.

Ar ôl creu gorchymyn (dull ‘buy/energy’) gellir cyflwyno ynni gydag oedi o sawl eiliad neu hyd yn oed funudau, felly wrth ddatblygu systemau awtomataidd argymhellir gwirio'r gorchymyn gweithredu o bryd i'w gilydd trwy ofyn am ddull ‘order/get/{guid}’.

Er enghraifft, os ydych chi'n bwriadu anfon USDT ac yn dymuno gwneud trafodion yn rhatach trwy brynu ynni, rydych chi'n gwneud y canlynol:

• gofyn am y dull ‘buy/energy’ i amcangyfrif swm ynni sydd ei angen a'i brynu,
• gofyn o bryd i'w gilydd am ddull ‘order/get/{guid}’ nes bod ynni'n cael ei ddirprwyo (fel arfer mae'n cymryd ychydig eiliadau),
• anfon USDT (bydd yr ynni a brynir yn cael ei ddefnyddio i dalu'r ffi trafodiad).

Nodiadau cyffredinol

Yn y ddogfennaeth hon, mae ymadrodd wedi'i lapio i mewn i freichiau cyrliog fel ‘{guid}’ neu ‘{id}’ yn golygu gwerth y newidyn cyfatebol:

• ‘{guid}’ yw dynodwr unigryw byd-eang y gwrthrych yn EnergyFather (8 digid fel arfer),
• ‘{id}’ yw rhif dilyniannol y gwrthrych ar gyfer y defnyddiwr hwn (mae rhifo yn dechrau gyda ‘1’ ar gyfer pob defnyddiwr).

API Diwedd Pwynt

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

Anfonwch geisiadau gan ddefnyddio dull POST.

Awdurdodi ceisiadau

I gadarnhau (awdurdodi) ceisiadau i API preifat, dylid pasio pennawd HTTP:

Token: {token}

Rheoli tocynnau awdurdodi wedi ei leoli yn y panel rheoli, ar y dudalen "Prynwr > API tocynnau".

Er enghraifft, gallwch gael gwybodaeth am orchymyn 123456 yn y ffordd ganlynol:

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

Statws gorchymyn

• "0" - Pending. Mae'r gorchymyn newydd gael ei greu.
• "1" - Aros am y taliad. Mae'r ddolen dalu eisoes wedi'i chynhyrchu, EnergyFather yn aros am alwad yn ôl o'r system dalu. Ni ddefnyddir y statws hwn os yw'r gorchymyn yn cael ei dalu'n gyfan gwbl gan arian sydd ar gael yn y cyfrif mewnol.
• "2" - Mae gweithdrefn dirprwyo ynni yn parhau.
• "3" - Dirprwyedig Mae egni yn cael ei roi allan.
• "4" - Adferwyd (Undelegated). Mae ynni'n cael ei dynnu'n ôl oherwydd diwedd y cyfnod amser cyflogedig.
• "5" - Talwyd. Mae'r gorchymyn yn cael ei dalu a'i ychwanegu yn y ciw ar gyfer cyflenwi ynni.
• "6" - Gwall.

Y dilyniant arferol o statws: 0, 5, 2, 3, 4.

Dull "buy/energy" – prynu ynni (wedi'i dalu o gyfrif mewnol)

Cais i brynu ynni gan gwsmer cofrestredig gyda debyd o'r cyfrif mewnol. Mae'r egni yn cael ei anfon yn syth i'r cyfeiriad penodedig.

Os nad oes gan y cyfrif mewnol ddigon o arian, bydd y gorchymyn yn cael ei greu ac ar unwaith yn cael statws "6" (Error). Yn yr achos hwn, mae angen i chi ymweld â'r panel, adneuo rhywfaint o arian ac yna anfon cais API newydd am brynu ynni.

Mae dwy ffordd o ddiffinio faint o ynni i'w brynu:

a) Gallwch osod yr union swm ynni yn y paramedr "amount", yna dylech hefyd osod amount_source="amount".

b) Os nad ydych chi'n gwybod faint o ynni sydd ei angen er mwyn i drafodiad anfon USDT neu docyn arall, gallwch chi osod amount_source="estimate" a llenwi'r paramedrau priodol (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Cais enghreifftiol gydag union faint o ynni

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: Cais enghreifftiol gyda chyfrifo faint o ynni sydd ei angen

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: Params cais

• to (llinynnol, gofynnol) - cyfeiriad TRON y mae'r egni i gael ei ddirprwyo iddo
• period_amount (cyfanrif, gofynnol) – cyfnod amser i brynu ynni
• period_type (llinynnol, gofynnol) – math o gyfnod amser. Gwerthoedd posibl: days, hours.
• format (llinynnol, dewisol) – fformat ymateb. Gwerthoedd posibl: json (default), xml.
• amount_source (llinyn, gofynnol) – algorithm ar gyfer penderfynu faint o egni dirprwyedig. Os yw'r gwerth yn "amount", yna defnyddir gwerth y paramedr "amount". Os yw'r gwerth yn "estimate", cyfrifir y swm gofynnol o ynni yn seiliedig ar y paramedrau estimate_to, estimate_token, estimate_adjust_percent. Gwerthoedd posibl: amount, estimate.
• amount (cyfanrif, sydd ei angen os amount_source="amount") – faint o ynni i'w brynu. Mae'n cael ei anwybyddu os amount_source="estimate".
• estimate_to (llinynnol, gofynnol os amount_source="estimate") - rhestr wedi'i gwahanu gan goma o gyfeiriadau TRON y bwriedir anfon trafodion symbolaidd atynt.
• estimate_token (llinynnol, gofynnol os amount_source="estimate") - y tocyn TRC20. Gwerthoedd posibl (sensitif i achosion): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
• estimate_adjust_percent (penderfynol, sy'n ofynnol os amount_source="estimate") – y swm gormodol o ynni a fynegir fel canran. Mae angen y gormodedd hwn i osgoi llosgi TRX, a all ddigwydd os oes gan y cyfeiriad yr union faint o egni angenrheidiol. Gwerth argymelledig yw 0.04%.

Pwysig: Ar hyn o bryd, dim ond 6 cyfnod sy'n ddilys: 1 hour a 1, 3, 7, 15, 30 days.

buy/energy: Ymateb

Mewn achos o lwyddiant, bydd yr ymateb yn cynnwys y gorchymyn GUID, lle gallwch gael ei fanylion gwirioneddol yn ddiweddarach.

{
	"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"
}

Os yw'r cais yn cynnwys amount_source="estimate" yna mae gan yr ymateb adran ychwanegol "estimate_task". Er enghraifft:

{
	"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: Paramedrau ymateb

• guid – y gorchymyn GUID
• balance – arian sydd ar gael ar hyn o bryd yn y cyfrif mewnol, TRX
• days – hyd y ddarpariaeth ynni mewn dyddiau, os "period_type=days"
• hours – hyd y ddarpariaeth ynni mewn oriau, os "period_type=hours"
• estimate_task – cyfrifo (amcangyfrif) o ynni sydd ei angen i anfon trafodion TRC20 o un cyfeiriad TRON i'r rhestr o gyfeiriadau TRON arall

Y dull "order/get/{guid}" – cael manylion y gorchymyn

Cael gwybodaeth am y gorchymyn penodol.

order/get/{guid} – Cais enghreifftiol

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

order/get/{guid} – Ymateb enghreifftiol

{
	"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} – Paramedrau ymateb

• guid – y gorchymyn GUID
• balance – arian sydd ar gael ar hyn o bryd yn y cyfrif mewnol, TRX
• days – hyd y ddarpariaeth ynni mewn dyddiau, os "period_type=days"
• hours – hyd y ddarpariaeth ynni mewn oriau, os "period_type=hours"
• to – cyfeiriad TRX lle mae ynni'n cael ei gyflenwi
• energy_amount – maint ynni
• order_cost - cost archebu, TRX
• order_cost_paid - swm sydd eisoes wedi'i dalu, TRX (rhag ofn nad oes digon o arian yn y cyfrif mewnol bydd y swm hwn yn llai na "order_cost")
• address_activation_fee – swm y ffi ar gyfer actifadu'r cyfeiriad cyrchfan, TRX
• energy_delegation_fee – ffi am faint archeb rhy fach, TRX
• resource_txs - amrywiaeth sy'n cynnwys y rhestr o drafodion mewn blockchain TRON lle mae adnoddau'n cael eu dirprwyo a'u hadennill (heb ei elegated)
• status - statws gorchymyn, gwerthoedd posibl yn cael eu disgrifio ar ddechrau'r llawlyfr hwn
• payment_status – statws talu archeb yn y system dalu (mae gwerthoedd posibl yn dibynnu ar y system dalu)

Y dull "order/list" – cael y rhestr o orchmynion

Cael y rhestr o orchmynion.

order/list – Cais enghreifftiol

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

order/list – Params cais

• sort (llinynnol, dewisol) – didoli ceisiadau, yn ddiofyn "created_at|desc"
• per_page (cyfanrif, dewisol) – cyfyngu ar nifer y ceisiadau fesul ymateb
• page (cyfanrif, dewisol) – rhif dilyniannol y dudalen ymateb
• filter (amrywiaeth o arrays(objects), dewisol) – hidlo cofnodion

order/list – Ymateb enghreifftiol

{
	"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 – Paramedrau ymateb

• guid – GUID o'r gorchymyn
• status – statws ymateb API

Y dull "account/list" – rhestru cyfrifon mewnol

Cael rhestr o gyfrifon mewnol, gan gynnwys faint o arian sydd ar gael ar hyn o bryd. Gan fod cyfrif mewnol ar wahân ar gyfer pob adran o'r safle (buyer, affiliate, seller, dealer), mae sawl cyfrif yn y cyfrif.

account/list – Cais enghreifftiol

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

account/list – Ymateb enghreifftiol

{
	"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 – Paramedrau ymateb

• guid – GUID o'r cyfrif mewnol
• id – ID dilyniannol o'r cyfrif mewnol
• section – yr adran EnergyFather y mae'r cydbwysedd hwn yn perthyn iddi
• balance – arian sydd ar gael
• currency – arian cyfred
• user_id – GUID y defnyddiwr

Y dull "account/get/{id}" – cael yr union gyfrif mewnol

Cael cydbwysedd y cyfrif mewnol ar gyfer adran benodol o EnergyFather. Gan fod gan bob adran ei chyfrif ei hun (buyer, affiliate, seller, dealer), mae sawl cyfrif ar gyfer pob defnyddiwr. Gallwch ddefnyddio'r dull "account/list" yn gyntaf i gael eu rhestr, darganfod y ‘id’ cyfrif llog, ac yna defnyddio'r ‘id’ hwn i gael cydbwysedd cyfrif penodol.

account/get/{id} – Cais enghreifftiol

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

account/get/{id} – Ymateb enghreifftiol

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

account/get/{id} – Params ymateb

• guid – GUID o'r cyfrif mewnol
• id - ID dilyniannol o'r cyfrif mewnol
• section - pa adran EnergyFather mae'r cydbwysedd hwn yn perthyn i
• balance - arian sydd ar gael
• currency - arian cyfred
• user_id - GUID y defnyddiwr