Dokumentazzjoni API

Proċedura tax-xiri tal-enerġija

Biex tixtri l-enerġija, trid tirreġistra fis-servizz EnergyFather, aqbad it-token ta 'awtorizzazzjoni mill-paġna "Xerrej > tokens API", u żżid il-bilanċ tal-kont tax-Xerrej.

Wara li tinħoloq ordni (metodu ‘buy/energy’) l-enerġija tista 'titwassal b'dewmien ta' diversi sekondi jew saħansitra minuti, għalhekk meta jiġu żviluppati sistemi awtomatizzati huwa rrakkomandat li perjodikament tivverifika l-eżekuzzjoni tal-ordni billi titlob metodu ‘order/get/{guid}’.

Pereżempju, jekk qed tippjana li tibgħat USDT u tixtieq tagħmel tranżazzjonijiet irħas billi tixtri l-enerġija, tagħmel dan li ġej:

• jitlob il-metodu ‘buy/energy’ biex jistma l-ammont ta' enerġija meħtieġ u jixtrih,
• perjodikament titlob il-metodu ‘order/get/{guid}’ sakemm tiġi ddelegata l-enerġija (normalment tieħu ftit sekondi),
• tibgħat USDT (l-enerġija mixtrija tintuża biex tħallas it-tariffa tat-tranżazzjoni).

Noti ġenerali

F'din id-dokumentazzjoni, espressjoni mgeżwra fi ċineg curly bħal ‘{guid}’ jew ‘{id}’ tfisser il-valur tal-varjabbli korrispondenti:

• ‘{guid}’ huwa l-identifikatur uniku globali tal-oġġett fil-EnergyFather (ġeneralment 8 ċifri),
• ‘{id}’ huwa n-numru sekwenzjali tal-oġġett għal dan l-utent (in-numerazzjoni tibda b'‘1’ għal kull utent).

API Punt tat-tmiem

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

Ibgħat talbiet bl-użu tal-metodu POST.

Awtorizzazzjoni ta' talbiet

Biex jiġu kkonfermati (awtorizzati) talbiet lil API privat, għandha tgħaddi intestatura tal-HTTP:

Token: {token}

Ġestjoni ta 'tokens ta' awtorizzazzjoni tinsab fil-pannell tal-kontroll, fuq il-paġna "Xerrejja > tokens API".

Pereżempju, tista' tikseb informazzjoni dwar l-ordni 123456 bil-mod li ġej:

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

Status tal-ordni

• "0" - Pendenti. L-ordni għadha kemm inħolqot.
• "1" - Stennija għall-ħlas. Il-link tal-ħlas diġà ġie ġġenerat, EnergyFather qed jistenna callback mis-sistema ta 'ħlas. Dan l-istatus ma jintużax jekk l-ordni titħallas kollha kemm hi minn fondi disponibbli fil-kont intern.
• "2" - Il-proċedura tad-delega tal-enerġija għadha għaddejja.
• "3" - Delegat. L-enerġija tingħata.
• "4" - Reklamat (mhux iddelegat). L-enerġija tiġi rtirata minħabba t-tmiem tal-perjodu ta' żmien imħallas.
• "5" - Imħallas. L-ordni titħallas u tiżdied fil-kju għall-kunsinna tal-enerġija.
• "6" - Żball.

Is-sekwenza tas-soltu ta 'statuses: 0, 5, 2, 3, 4.

Il-metodu "buy/energy" - jixtru l-enerġija (imħallsa mill-kont intern)

Talba għax-xiri tal-enerġija minn klijent irreġistrat b'debitu mill-kont intern. L-enerġija tintbagħat immedjatament fl-indirizz speċifikat.

Jekk il-kont intern ma jkollux fondi insuffiċjenti, l-ordni tinħoloq u immedjatament tikseb status "6" (Żball). F'dan il-każ għandek bżonn iżżur il-pannell, tiddepożita xi fondi u mbagħad tibgħat talba ġdida tal-API għax-xiri tal-enerġija.

Hemm żewġ modi kif jiġi definit l-ammont ta' enerġija li għandha tinxtara:

a) Tista 'tissettja l-ammont eżatt ta' enerġija fil-parametru "amount", allura għandek tissettja wkoll amount_source="amount".

b) Jekk ma tafx kemm hija meħtieġa enerġija għal tranżazzjoni biex tibgħat USDT jew token ieħor, tista 'tissettja amount_source="estimate" u timla l-parametri xierqa (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Eżempju ta 'talba b'ammont eżatt ta' enerġija

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: Eżempju ta' talba bil-kalkolu tal-ammont meħtieġ ta' enerġija

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: Itlob parami

• to (sekwenza, meħtieġa) – indirizz TRON li lilu għandha tiġi ddelegata l-enerġija
• period_amount (numru sħiħ, meħtieġ) - perjodu ta 'żmien biex tixtri l-enerġija
• period_type (sekwenza, meħtieġa) – tip ta' perjodu ta' żmien. Valuri possibbli: days, hours.
• format (sekwenza, fakultattiva) - format ta 'rispons. Valuri possibbli: json (default), xml.
• amount_source (string, meħtieġa) – algoritmu għad-determinazzjoni tal-ammont ta' enerġija ddelegata. Jekk il-valur huwa "amount", allura jintuża l-valur tal-parametru "amount". Jekk il-valur huwa "estimate", l-ammont meħtieġ ta' enerġija huwa kkalkulat abbażi tal-parametri estimate_to, estimate_token, estimate_adjust_percent. Valuri possibbli: amount, estimate.
• amount (numru sħiħ, meħtieġ jekk amount_source="amount") – ammont ta' enerġija li għandha tinxtara. Huwa injorat jekk amount_source="estimate".
• estimate_to (sekwenza, meħtieġa jekk amount_source="estimate") – lista separata mill-virgola ta' indirizzi TRON li lilhom huma ppjanati li jintbagħtu tranżazzjonijiet ta' token
• estimate_token (sekwenza, meħtieġa jekk amount_source="estimate") - it-token TRC20. Valuri possibbli (sensittivi għall-każijiet): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
• estimate_adjust_percent (deċimali, meħtieġ jekk amount_source="estimate") – l-ammont żejjed ta' enerġija espress bħala perċentwal. Dan l-eċċess huwa meħtieġ biex jiġi evitat li jinħaraq TRX, li jista 'jiġri jekk l-indirizz ikollu eżattament l-ammont meħtieġ ta' enerġija. Il-valur rakkomandat huwa 0.04%.

Importanti: Bħalissa, 6 perjodi biss huma validi: 1 hour u 1, 3, 7, 15, 30 days.

buy/energy: Rispons

F'każ ta 'suċċess, ir-risposta jkun fiha l-ordni GUID, li biha tista' aktar tard tikseb id-dettalji attwali tagħha.

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

Jekk it-talba jkun fiha amount_source="estimate" allura r-rispons ikollu taqsima addizzjonali "estimate_task". Pereżempju:

{
	"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: Parami ta' rispons

• guid – l-ordni GUID
• balance – fondi attwalment disponibbli fil-kont intern, TRX
• days – it-tul tal-provvista tal-enerġija fi ġranet, jekk "period_type=days"
• hours – it-tul tal-provvista tal-enerġija f'sigħat, jekk il-"period_type=hours"
• estimate_task – kalkolu (stima) tal-enerġija meħtieġa biex jintbagħtu tranżazzjonijiet TRC20 minn indirizz wieħed tal-TRON lil-lista ta' indirizzi oħra tal-TRON

Il-metodu "order/get/{guid}" - tikseb dettalji tal-ordni

Il-kisba ta' informazzjoni dwar l-ordni speċifika.

order/get/{guid} – Talba għal eżempju

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

order/get/{guid} - Eżempju ta 'rispons

{
	"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} – Parami ta' rispons

• guid – l-ordni GUID
• balance – fondi attwalment disponibbli fil-kont intern, TRX
• days – it-tul tal-provvista tal-enerġija fi ġranet, jekk "period_type=days"
• hours – it-tul tal-provvista tal-enerġija f'sigħat, jekk il-"period_type=hours"
• to – indirizz TRX fejn titwassal l-enerġija
• energy_amount – kwantità ta' enerġija
• order_cost – spiża tal-ordni, TRX
• order_cost_paid – ammont diġà mħallas, TRX (f'każ ta' fondi insuffiċjenti fil-kont intern dan l-ammont se jkun inqas minn "order_cost")
• address_activation_fee – ammont ta' tariffa għall-attivazzjoni tal-indirizz tad-destinazzjoni, TRX
• energy_delegation_fee - tariffa għal daqs ta 'ordni żgħir wisq, TRX
• resource_txs – firxa li fiha l-lista ta' tranżazzjonijiet fil-blockchain TRON fejn ir-riżorsi jiġu ddelegati u rkuprati (mhux iddelegati)
• status – status ta' ordni, valuri possibbli huma deskritti fil-bidu ta' dan il-manwal
• payment_status – status ta' ħlas ta' ordni fis-sistema ta' pagament (il-valuri possibbli jiddependu fuq is-sistema ta' pagament)

Il-metodu "order/list" - tikseb il-lista ta 'ordnijiet

Jkollna l-lista ta 'ordnijiet.

order/list - Eżempju ta 'talba

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

order/list – Itlob parami

• sort (sekwenza, fakultattiva) – l-issortjar tal-entrati, awtomatikament "created_at|desc"
• per_page (numru sħiħ, fakultattiv) – illimita n-numru ta' entrati għal kull rispons
• page (numru sħiħ, fakultattiv) – numru sekwenzjali tal-paġna ta' rispons
• filter (firxa ta' arrays(objects), fakultattiva) – filtru tal-entrati

order/list - Eżempju ta 'rispons

{
	"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 – Parami ta' rispons

• guid – GUID tal-ordni
• status – status tar-rispons tal-API

Il-metodu "account/list" – elenkar tal-kontijiet interni

Il-kisba ta' lista ta' kontijiet interni, inkluż l-ammont ta' fondi disponibbli bħalissa. Peress li hemm kont intern separat għal kull taqsima tas-sit (buyer, affiliate, seller, dealer), hemm kontijiet multipli fil-kont.

account/list - Eżempju ta 'talba

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

account/list - Eżempju ta 'rispons

{
	"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 – Parami ta' rispons

• guid – GUID tal-kont intern
• id – ID sekwenzjali tal-kont intern
• section – li għalih tappartjeni t-taqsima EnergyFather dan il-bilanċ
• balance – fondi disponibbli
• currency – munita
• user_id – GUID tal-utent

Il-metodu "account/get/{id}" - tikseb il-kont intern eżatt

Il-kisba tal-bilanċ tal-kont intern għal taqsima speċifika tal-EnergyFather. Peress li kull taqsima għandha l-kont tagħha (buyer, affiliate, seller, dealer), hemm diversi kontijiet għal kull utent. L-ewwel tista 'tuża l-metodu "account/list" biex tikseb il-lista tagħhom, issir taf il-‘id’ tal-kont ta' interess, u mbagħad tuża dan il-‘id’ biex tikseb il-bilanċ ta 'kont partikolari.

account/get/{id} – Eżempju ta' talba

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

account/get/{id} – Eżempju ta' rispons

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

account/get/{id} – Parami ta' rispons

• guid – GUID tal-kont intern
• id - ID sekwenzjali tal-kont intern
• section - li t-taqsima EnergyFather dan il-bilanċ jappartjeni għaliha
• balance - fondi disponibbli
• currency - munita
• user_id - GUID tal-utent