API-dokumentasjon

EnergyFather-tjenesten bidrar til å kjøpe (leie) energien og båndbredden som trengs for å sende transaksjoner i USDT og andre TRC20-kryptotokener; båndbredde er også nødvendig for å sende alle typer transaksjoner på TRON-blokkjeden, for eksempel å sende TRX, kreve belønninger og stemme for Super Representatives.

Prosedyre for kjøp av energi

For å kjøpe energi må du registrere deg i EnergyFather-tjenesten, hente autorisasjonstokenet fra siden "Buyer > API tokens", og fylle opp saldoen på kjøperkontoen.

Etter at du har opprettet en ordre (metode ‘buy/energy’), kan energi leveres med en forsinkelse på flere sekunder eller til og med minutter, så når du utvikler automatiserte systemer, anbefales det å sjekke ordreutførelsen med jevne mellomrom ved å be om metoden ‘order/get/{guid}’.

Hvis du for eksempel planlegger å sende USDT og ønsker å gjøre transaksjonene billigere ved å kjøpe energi, gjør du følgende

  • be om ‘buy/energy’-metoden for å estimere nødvendig energimengde og kjøpe den,
  • med jevne mellomrom be om ‘order/get/{guid}’-metoden til energien er delegert (vanligvis tar det noen sekunder),
  • send USDT (den kjøpte energien vil bli brukt til å betale transaksjonsgebyret).

Generelle merknader

I denne dokumentasjonen betyr et uttrykk pakket inn i krøllparenteser som ‘{guid}’ eller ‘{id}’ verdien av den tilsvarende variabelen:

  • ‘{guid}’ er den globale unike identifikatoren for objektet i EnergyFather (vanligvis 8 siffer),
  • ‘{id}’ er objektets løpenummer for denne brukeren (nummereringen starter med ‘1’ for hver bruker).

API Sluttpunkt

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

Send forespørsler ved hjelp av POST-metoden.

Godkjenning av forespørsler

For å bekrefte (autorisere) forespørsler til en privat API, skal det sendes et HTTP-overskriftsledd:

Token: {token}

Administrasjon av autorisasjonstokener finner du i kontrollpanelet, på siden "Kjøper > API-tokens".

Du kan for eksempel få informasjon om bestilling 123456 på følgende måte:

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

Bestillingsstatus

  • "0" - Avventer. Bestillingen har nettopp blitt opprettet.
  • "1" - Venter på betaling. Betalingslenken er allerede generert, EnergyFather venter på en tilbakekalling fra betalingssystemet. Denne statusen brukes ikke hvis bestillingen i sin helhet betales med midler som er tilgjengelige på den interne kontoen.
  • "2" - Prosedyre for energidelegering pågår.
  • "3" - Delegert. Energi er gitt ut.
  • "4" - Tilbakekrevd (udelegert). Energi trekkes tilbake på grunn av utløpet av den betalte tidsperioden.
  • "5" - Betalt. Bestillingen er betalt og lagt til i køen for energileveranse.
  • "6" - Feil.

Den vanlige sekvensen av statuser: 0, 5, 2, 3, 4.

API-metoder
  • /api/v1/private/buy/energy - kjøp av energi (betalt fra intern konto)
  • /api/v1/private/order/list - få en liste over bestillingene dine
  • /api/v1/private/order/get/{guid} - få informasjon om bestillingen din
  • /api/v1/private/account/list - få en liste over dine interne kontoer
  • /api/v1/private/account/get/{id} - få informasjon om din interne konto

"buy/energy"-metoden - kjøp av energi (betalt fra intern konto)

Forespørsel om kjøp av energi fra en registrert kunde med belastning fra internkonto. Energien sendes umiddelbart til den angitte adressen.

Hvis den interne kontoen ikke har tilstrekkelige midler, vil bestillingen bli opprettet og umiddelbart få status "6" (feil). I dette tilfellet må du besøke panelet, sette inn penger og deretter sende en ny API-forespørsel om kjøp av energi.

Det finnes to måter å definere mengden energi som skal kjøpes:

a) Du kan angi den nøyaktige energimengden i parameteren "amount", og da bør du også angi amount_source="amount".

b) Hvis du ikke vet hvor mye energi som kreves for en transaksjon for å sende USDT eller et annet token, kan du angi amount_source="estimate" og fylle inn de aktuelle parameterne (estimate_to, estimate_token, estimate_adjust_percent).

buy/energy: Eksempel på forespørsel med nøyaktig energimengde

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: Eksempel på forespørsel med beregning av nødvendig energimengde

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: Forespørsel om parametere

  • to (string, obligatorisk) - TRON-adresse som energien skal delegeres til
  • period_amount (heltall, obligatorisk) - tidsperiode for kjøp av energi
  • period_type (string, obligatorisk) - type tidsperiode. Mulige verdier: days, hours.
  • format (string, valgfri) - svarformat. Mulige verdier: json (default), xml.
  • amount_source (string, påkrevd) - algoritme for å bestemme mengden delegert energi. Hvis verdien er "amount", brukes verdien av parameteren "amount". Hvis verdien er "estimate", beregnes den nødvendige energimengden basert på parameterne estimate_to, estimate_token, estimate_adjust_percent. Mulige verdier: amount, estimate.
  • amount (heltall, påkrevd hvis amount_source="amount") - energimengde som skal kjøpes. Ignoreres hvis amount_source="estimate".
  • estimate_to (string, obligatorisk hvis amount_source="estimate") - kommaseparert liste over TRON-adresser som token-transaksjoner planlegges sendt til
  • estimate_token (string, påkrevd hvis amount_source="estimate") - TRC20-tokenet. Mulige verdier (skiller mellom store og små bokstaver): USDT, USDC, USDD, USDJ, JST, TUSD, stUSDT, WTRX.
  • estimate_adjust_percent (desimal, påkrevd hvis amount_source="estimate") - den overskytende energimengden uttrykt i prosent. Dette overskuddet er nødvendig for å unngå å brenne TRX, noe som kan skje hvis adressen har nøyaktig den nødvendige energimengden. Anbefalt verdi er 0.04%.

Viktig: For øyeblikket er bare 6 perioder gyldige: 1 hour og 1, 3, 7, 15, 30 days.

buy/energy: Svar

Hvis det lykkes, vil svaret inneholde bestillingen GUID, som du senere kan få de faktiske detaljene.

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

Hvis forespørselen inneholder amount_source="estimate", har svaret en ekstra seksjon "estimate_task". For eksempel

{
	"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: Svarparametere

  • guid - rekkefølgen GUID
  • balance - midler som for tiden er tilgjengelige på den interne kontoen, TRX
  • days - varigheten av energileveransen i dager, hvis "period_type=days"
  • hours - varigheten av energileveransen i timer, hvis "period_type=hours"
  • estimate_task - beregning (estimering) av energi som trengs for å sende TRC20-transaksjoner fra en TRON-adresse til listen over andre TRON-adresser

"order/get/{guid}"-metoden - innhenting av detaljer om bestillingen

Innhenting av informasjon om den spesifikke bestillingen.

order/get/{guid} - Eksempel på forespørsel

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

order/get/{guid} - Eksempel på svar

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

  • guid - rekkefølgen GUID
  • balance - midler som for tiden er tilgjengelige på den interne kontoen, TRX
  • days - varigheten av energileveransen i dager, hvis "period_type=days"
  • hours - varigheten av energileveransen i timer, hvis "period_type=hours"
  • to - TRX adresse der energien leveres
  • energy_amount - energimengde
  • order_cost - ordrekostnad, TRX
  • order_cost_paid - allerede innbetalt beløp, TRX (i tilfelle utilstrekkelige midler på internkontoen vil dette beløpet være mindre enn "order_cost")
  • address_activation_fee - avgiftsbeløp for aktivering av destinasjonsadressen, TRX
  • energy_delegation_fee - gebyr for for liten ordrestørrelse, TRX
  • resource_txs - matrise som inneholder listen over transaksjoner i TRON-blokkjeden der ressurser er delegert og gjenvunnet (undelegated)
  • status - ordrestatus, mulige verdier er beskrevet i begynnelsen av denne håndboken
  • payment_status - status for ordrebetaling i betalingssystemet (mulige verdier avhenger av betalingssystemet)

"order/list"-metoden - henter listen over bestillinger

Henter listen over bestillinger.

order/list - Eksempel på forespørsel

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

order/list - Forespørsel om parametere

  • sort (string, valgfri) - sortering av oppføringer, som standard "created_at|desc"
  • per_page (heltall, valgfritt) - begrens antall oppføringer per svar
  • page (heltall, valgfritt) - løpenummer på svarsiden
  • filter (matrise av arrays(objects), valgfritt) - filter av oppføringer

order/list - Eksempel på svar

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

  • guid - GUID for bestillingen
  • status - status for API-svar

"account/list"-metoden - opplisting av interne kontoer

Få en liste over interne kontoer, inkludert beløpet som for øyeblikket er tilgjengelig. Siden det er en egen internkonto for hver del av nettstedet (buyer, affiliate, seller, dealer), er det flere kontoer i kontoen.

account/list - Eksempel på forespørsel

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

account/list - Eksempel på svar

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

  • guid - GUID for den interne kontoen
  • id - sekvensiell ID av den interne kontoen
  • section - hvilken EnergyFather-seksjon denne saldoen tilhører
  • balance - tilgjengelige midler
  • currency - valuta
  • user_id - GUID av brukeren

"account/get/{id}"-metoden - få den nøyaktige interne kontoen

Innhenting av saldo på den interne kontoen for en bestemt seksjon i EnergyFather. Siden hver seksjon har sin egen konto (buyer, affiliate, seller, dealer), finnes det flere kontoer for hver bruker. Du kan først bruke "account/list"-metoden for å få listen over dem, finne ut ‘id’ for den kontoen du er interessert i, og deretter bruke denne ‘id’ for å få saldoen på en bestemt konto.

account/get/{id} - Eksempel på forespørsel

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

account/get/{id} - Eksempel på svar

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

account/get/{id} - Svarparametere

  • guid - GUID for den interne kontoen
  • id - sekvensiell ID for den interne kontoen
  • section - hvilken EnergyFather-seksjon denne saldoen tilhører
  • balance - tilgjengelige midler
  • currency - valuta
  • user_id - GUID av brukeren