API интеграция для TR.ENERGY
Что такое ключ API и зачем он нужен Tr.energy?
API-ключ представляет собой специальный механизм аутентификации, применяемый для обеспечения безопасности API-сервиса Tr.energy и предотвращения несанкционированного доступа к вашим данным. Это уникальная строка, которую генерирует система и назначает каждому пользователю для подтверждения их легитимности при обращении к API. Пользователям необходимо включать API-ключ в заголовок своих запросов, чтобы доказать свою идентификацию. Это предотвращает возможные злонамеренные атаки и злоупотребления, защищая целостность и работоспособность нашей системы.
Как получить API ключ
1. Авторизуйтесь в системе и перейдите на страницу Настроек в раздел API.
2. Нажмите кнопку «Сгенерировать», чтобы получить ключ. Затем система сгенерирует для вас уникальный ключ API.
3. Скопируйте сгенерированный токен API-ключа в свое приложение, чтобы аутентифицировать свою личность при вызове службы API Tr.energy.
4. Пройдите по ссылке ознакомьтесь с методом взаимодействия с нашим API.
Примечания
1. Не раскрывайте свой ключ API никому, чтобы предотвратить его нежелательное использование.
2. Если ваш ключ API утерян, немедленно свяжитесь с нашей службой поддержки - [email protected]
3. Если вам нужна дополнительная помощь или вы столкнулись с какой-либо проблемой, напишите нам - [email protected]
1. АВТОРИЗАЦИЯ
Происходит автоматически при использования API ключа в header (Bearer Token)
2. ПРОВЕРКА БАЛАНСА
Используйте метод GET 1.1. Show
3. ПОПОЛНЕНИЕ БАЛАНСА
Используйте метод GET 1.2. Top up
4. СОЗДАНИЕ ЗАКАЗА ЭНЕРГИИ
Используйте метод GET 2.2. Create
5. ВЫВОД СПИСКА ПОТРЕБИТЕЛЕЙ ЭНЕРГИИ
(Это кошельки, на которые делегируется энергия)
Чтобы отобразить 1 адрес используйте метод GET 2.3. Show
Чтобы отобразить все адреса используйте метод GET 2.1. Index
6. ОБНОВЛЕНИЕ ДАННЫХ ПОТРЕБИТЕЛЕЙ ЭНЕРГИИ
(Вы можете изменить имя потребителя, кол-во энергии, срок аренды энергии, тип потребителя: динамический/статический, статус автопродления)
Используйте метод PATCH 2.7. Update
функция автопродления - POST 2.9. Toggle Auto Renewal
7. АКТИВИРОВАНИЕ ЗАКАЗА ЭНЕРГИИ
Используйте метод POST 2.4. Activate
8. ДЕАКТИВИРОВАНИЕ ЗАКАЗА ЭНЕРГИИ
Используйте метод POST 2.5. Deactivate
9. УДАЛЕНИЕ ПОТРЕБИТЕЛЯ ЭНЕРГИИ
Используйте метод DELETE 2.8. Destroy
Как реализовать работу транзитных кошельков с TR.ENERGY
Создаете новый кошелек в вашей системе, принимаете туда криптовалюту от клиентов, проверяете “чистоту” транзакции. Если вас устраивает результат, то можно отправлять эти средства на свой основной кошелек. Для одной транзакции достаточно 64к-130к энергии (в зависимости от загрузки сети TRON)
Для этого необходимо создать заказ энергии на этот кошелек
Используем метод POST 2.2. Create. Создаем запрос со следующими параметрами:
{
"payment_period": 1,
"address": "TY3dRk4eQ75dCrW7tUcCzggU9rnz4V111",
"auto_renewal": 0,
"consumption_type": 1,
"resource_amount": 70000,
"name": "transit-TY3dR"
}
Получаем ответ на запрос
{
"data": {
"id": 1,
"name": "transit-TY3dR",
"address": "TY3dRk4eQ75dCrW7tUcCzggU9rnz4V1111",
"resource_amount": "70000",
"creation_type": 2,
"consumption_type": 1,
"payment_period": 1,
"auto_renewal": false,
"resource_consumptions": null,
"is_active": false,
"order": null,
"created_at": "30-10-2023 06:58:17",
"updated_at": "30-10-2023 06:58:17"
},
"status": true
}
Далее активируем заказ, на основе полученных данных
создаем запрос POST 2.4. Activate со следующими параметрами:
core.tr.energy/api/consumers/{ID_вашего_потребителя}/activate
Если баланса достаточно, ожидайте наполнения энергией несколько минут и можете осуществлять перевод.
