API dokumentáció

Energiavásárlási eljárás

Ahhoz, hogy energiát vásárolhass, regisztrálnod kell a EnergyFather szolgáltatásban, meg kell szerezned az engedélyezési tokent a "Vevő > API tokenek" oldalon, és fel kell töltened a Vevő számlaegyenlegét.

A megbízás létrehozása után (‘buy/energy’ módszer) az energia több másodperces vagy akár perces késéssel szállítható, ezért automatizált rendszerek fejlesztésénél ajánlott a megbízás végrehajtását rendszeresen ellenőrizni a ‘order/get/{guid}’ módszer kérésével.

Ha például USDT küldést tervezel, és energiavásárlással szeretnéd olcsóbbá tenni a tranzakciókat, akkor a következőket kell tenned:

• kérje a ‘buy/energy’ módszert a szükséges energiamennyiség becslésére és megvásárlására,
• rendszeresen kéri a ‘order/get/{guid}’ módszert, amíg az energia nem kerül delegálásra (ez általában néhány másodpercig tart),
• küldje el USDT (a megvásárolt energiát a tranzakciós díj kifizetésére fordítják).

Általános megjegyzések

Ebben a dokumentációban a szögletes zárójelekbe foglalt kifejezések, mint például ‘{guid}’ vagy ‘{id}’, a megfelelő változó értékét jelentik:

• ‘{guid}’ az objektum globális egyedi azonosítója EnergyFather-ban (általában 8 számjegyű),
• ‘{id}’ az adott felhasználó objektumának sorszáma (a számozás minden felhasználó esetében ‘1’-vel kezdődik).

API Végpont

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

Ne küldj kéréseket a POST módszerrel.

A kérelmek engedélyezése

A privát API kérések megerősítéséhez (engedélyezéséhez) egy HTTP fejlécet kell átadni:

Token: {token}

Az engedélyezési tokenek kezelése a vezérlőpulton található, a "Vevő > API tokenek" oldalon.

Például az 123456-os rendelésről a következő módon kaphat információt:

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

Megrendelés státusza

• "0" - függőben. A megrendelést most hozták létre.
• "1" - Várjuk a fizetést. A fizetési link már generálásra került, EnergyFather a fizetési rendszer visszahívására vár. Ez az állapot nem használható, ha a megrendelés teljes egészében a belső számlán rendelkezésre álló pénzeszközökből kerül kifizetésre.
• "2" - Az energia delegálásának eljárása folyamatban van.
• "3" - delegált. Az energia kiosztásra kerül.
• "4" - Visszakövetelt (nem delegált). A kifizetett időszak lejárta miatt visszavont energia.
• "5" - Fizetett. A megrendelés kifizetésre került, és hozzáadódik az energiaszállítási sorba.
• "6" - Hiba.

Az állapotok szokásos sorrendje: 0, 5, 2, 3, 4.

A "buy/energy" módszer - energiavásárlás (belső számláról fizetve)

Egy regisztrált ügyfél energiavásárlási kérelme a belső számláról történő terheléssel. Az energia azonnal elküldésre kerül a megadott címre.

Ha a belső számlán nincs elegendő fedezet, a megrendelés létrejön, és azonnal "6" (Hiba) státuszt kap. Ebben az esetben meg kell látogatnia a panelt, befizetni némi pénzt, majd elküldeni egy új API energiavásárlási kérelmet.

A megvásárolni kívánt energia mennyiségét kétféleképpen lehet meghatározni:

a) A pontos energiamennyiséget a "amount" paraméterben állíthatod be, akkor a amount_source="amount" értéket is be kell állítanod.

b) Ha nem tudod, hogy mennyi energia szükséges egy tranzakcióhoz USDT vagy egy másik token elküldéséhez, beállíthatod amount_source="estimate" és kitöltheted a megfelelő paramétereket (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Példa kérés a pontos energiamennyiséggel

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: Példa kérés a szükséges energiamennyiség kiszámításával

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: Paraméterek kérése

• to (string, kötelező) - TRON cím, amelyre az energiát delegálni kell.
• period_amount (egész szám, kötelező) - az energiavásárlás időtartama
• period_type (string, kötelező) - az időszak típusa. Lehetséges értékek: days, hours.
• format (string, opcionális) - válaszformátum. Lehetséges értékek: json (default), xml.
• amount_source (string, kötelező) - a delegált energia mennyiségének meghatározására szolgáló algoritmus. Ha az érték "amount", akkor a "amount" paraméter értéke kerül felhasználásra. Ha az érték "estimate", akkor a szükséges energiamennyiség kiszámítása a estimate_to, estimate_token, estimate_adjust_percent paraméterek alapján történik. Lehetséges értékek: amount, estimate.
• amount (egész szám, kötelező, ha amount_source="amount") - a megvásárolni kívánt energia mennyisége. Figyelmen kívül hagyjuk, ha amount_source="estimate".
• estimate_to (string, kötelező, ha amount_source="estimate") - azon TRON címek vesszővel elválasztott listája, amelyekre a token tranzakciókat tervezik elküldeni.
• estimate_token (string, kötelező, ha amount_source="estimate") - a TRC20 token. Lehetséges értékek (nagy- és kisbetű-érzékeny): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
• estimate_adjust_percent (tizedes, kötelező, ha amount_source="estimate") - a többletenergia mennyisége százalékban kifejezve. Erre a többletre azért van szükség, hogy elkerüljük az elégetést TRX, ami akkor fordulhat elő, ha a cím pontosan a szükséges energiamennyiséggel rendelkezik. Az ajánlott érték 0.04%.

Fontos: Jelenleg csak 6 időszak érvényes: 1 hour és 1, 3, 7, 15, 30 days.

buy/energy: Válasz

Siker esetén a válasz tartalmazza a megrendelést GUID, amely alapján később megkaphatod a tényleges részleteket.

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

Ha a kérés amount_source="estimate"-t tartalmaz, akkor a válasz egy további "estimate_task" szakaszt tartalmaz. Például:

{
	"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: Válaszparaméterek

• guid - a megrendelés GUID
• balance - a belső számlán jelenleg rendelkezésre álló pénzeszközök, TRX
• days - az energiaellátás időtartama napokban, ha "period_type=days"
• hours - az energiaellátás időtartama órákban, ha "period_type=hours"
• estimate_task - az egyik TRON címről a másik TRON címek listájára történő TRC20 tranzakciók küldéséhez szükséges energia kiszámítása (becslése).

A "order/get/{guid}" módszer - a megrendelés részleteinek lekérdezése

Információk beszerzése az adott megrendelésről.

order/get/{guid} - Példa kérés

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

order/get/{guid} - Példa válaszra

{
	"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} - Válaszparaméterek

• guid - a megrendelés GUID
• balance - a belső számlán jelenleg rendelkezésre álló pénzeszközök, TRX
• days - az energiaellátás időtartama napokban, ha "period_type=days"
• hours - az energiaellátás időtartama órákban, ha "period_type=hours"
• to - TRX cím, ahová az energiát szállítják
• energy_amount - energiamennyiség
• order_cost - rendelési költség, TRX
• order_cost_paid - már kifizetett összeg, TRX (amennyiben a belső számlán nincs elegendő fedezet, ez az összeg kevesebb lesz, mint "order_cost")
• address_activation_fee - a célcím aktiválásáért fizetendő díj összege, TRX
• energy_delegation_fee - díj a túl kicsi rendelés mérete miatt, TRX
• resource_txs - a TRON blokkláncban lévő tranzakciók listáját tartalmazó tömb, ahol az erőforrásokat delegálták és visszakövetelték (nem delegált)
• status - rendelési státusz, a lehetséges értékek a kézikönyv elején találhatók.
• payment_status - a megbízás fizetési státusza a fizetési rendszerben (a lehetséges értékek a fizetési rendszertől függnek)

A "order/list" módszer - a rendelések listájának lekérdezése

Megkapja a megrendelések listáját.

order/list - Példa kérés

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

order/list - Paraméterek kérése

• sort (string, opcionális) - a bejegyzések rendezése, alapértelmezés szerint "created_at|desc"
• per_page (egész szám, opcionális) - a válaszonként megadott bejegyzések számának korlátozása.
• page (egész szám, opcionális) - a válaszoldal sorszáma
• filter (arrays(objects) tömb, opcionális) - a bejegyzések szűrője

order/list - Példa válasz

{
	"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 - Válaszparaméterek

• guid - a megrendelés GUID azonosítója
• status - a API válasz állapota

A "account/list" módszer - a belső számlák felsorolása

A belső számlák listájának beszerzése, beleértve a jelenleg rendelkezésre álló pénzeszközök összegét. Mivel a webhely minden egyes részlegéhez külön belső számla tartozik (buyer, affiliate, seller, dealer), a számlán több számla is van.

account/list - Példa kérés

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

account/list - Példa válasz

{
	"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 - Válaszparaméterek

• guid - GUID a belső számla guid - GUID a belső számlán
• id - a belső számla szekvenciális ID-ja
• section - melyik EnergyFather szakaszhoz tartozik ez az egyenleg
• balance - rendelkezésre álló pénzeszközök
• currency - pénznem
• user_id - GUID a felhasználóról

A "account/get/{id}" módszer - a pontos belső számla megszerzése

A belső számla egyenlegének lekérdezése a EnergyFather egy adott szakaszához. Mivel minden szekciónak saját számlája van (buyer, affiliate, seller, dealer), minden felhasználónak több számlája is van. Először a "account/list" módszerrel megkaphatod a listájukat, megtudhatod az érdeklődésedre számot adó számla ‘id’-jét, majd ezt a ‘id’-t használhatod egy adott számla egyenlegének lekérdezésére.

account/get/{id} - Példa kérés

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

account/get/{id} - Példa válaszra

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

account/get/{id} - Válaszparaméterek

• guid - GUID a belső számla guid - GUID a belső számlán
• id - a belső számla szekvenciális azonosítója
• section - melyik EnergyFather szakaszhoz tartozik ez a mérleg
• balance - rendelkezésre álló pénzeszközök
• currency - pénznem
• user_id - GUID a felhasználóról