Versions Compared

Old Version 23

changes.mady.by.user Que Nguyen

Saved on

compared with

New Version 24

changes.mady.by.user allen li

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Allow user to get Fuel Types with filter. This Fuel Type will be used afterward.

Table of Contents

Table of Contents
stylenone

Changelogs

Version

Date

Changes by

Description of change

V 1.0.1

Allen Li

  • Added document

Fuel Types Information Resource

Id Registry.Value text

Fuel Type id

能源 Id

RegistryName text - enum (IREC - TIGR)

Registry Name

注册处名称

EnergyValue text

Energy Registry Value

注册处

Registry.Description text

Registry Decscription

注册处描述

FuelKind text

Fuel Value

能源类型值

RegistryFuelName FuelKindCode text

Registry Fuel NameKind Code

注册处能源名称能源类型编码

RegistryCode FuelName text

Registry CodeFuel Name

注册处能源代码

RedexFuelCode FuelShortCode text

Redex Fuel Short Code

Redex 能源代码

RedexFuelName text

Redex Fuel Name

Redex 能源名称

ForDeviceType text

For Device Type

能源类型所适用于设备类型能源代码缩写

Code Block
languagejson
{
    "IdRegistry": {
   1,     "RegistryNameValue": "IREC",
        "EnergyValueDescription": "Solar"I-REC"
    },
    "RegistryFuelNameFuelKind": "GroupBiomass Solar Rooftop",
    "RegistryCode": "ES110Solid: Industrial and commercial waste",
    "RedexFuelCodeFuelKindCode": "ES110ES520",
    "RedexFuelNameFuelName": "Group Solar RooftopBiomass",
    "ForDeviceTypeFuelShortCode": "GroupedBMS"
}

Fuel

Energy

types

Value

Short Code

Biogas/沼气

BGS

Biomass/生物

BMS

Co-fired with fossil/化石共生能

CFF

Geothermal/地热能

GTM

Hydro/氢能

HYD

Marine Current/海洋洋流能

MRC

Marine Tidal/海洋潮汐能

MRT

Marine Vertical Pressure/海洋垂直压力能

MRP

Marine Wave/海洋浪能

MRW

Nuclear/核能

NUC

Solar/太阳能

SLR

Wind/风能

WND

API Definitions

Status
colourGreen
titleGET
/public/v2/metadata/energies

Request

Headers

Authorization text

Authorization Bearer access token

Ex: Bearer {{access_token}}

Query Parameters

FuelKind (optional) Text

能源类型（可选）

Fuel Kind mapping to RedexFuelName

能源类型对应能源类型资源表中的 RedexFuelName 字段

FuelName (optional) Text

能源名称（可选）

Fuel name mapping value

能源名称对应能源类型资源表中的 Value

Registry (optional) text - Enum (IREC - TIGR)

注册处（可选）文本类型 - 枚举（IRECT - TIGR）

Registry Enum values

注册处枚举值

CurrentPage (optional) Numeric

Request field for pagination. The Page that you wish to view

用于分页的请求字段

ItemsPerPage (optional) Numeric

The total items that return in the response

分页的每页数据数

Code Block
curl --location 'https://uat-api.redex.eco/public/v2/metadata/energies?FuelKind=Biomass&FuelName=Biomass&Registry=IREC' \
--header 'Authorization: Bearer xxx'

Response

Response Body

Data array objects - Fuel Types information resource

能源类型信息资源

The array objects of Fuel Types information resource

能源类型信息资源对象

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info

200 OK

Code Block
languagejson
{
    "Data": [
        {
            "Registry": {
                "Value": "IREC",
                "Description": "I-REC"
            },
            "FuelKind": "Biomass Solid: Industrial and commercial waste",
            "FuelKindCode": "ES520",
            "FuelName": "Biomass",
            "FuelShortCode": "BMS"
        },
        {
            "Registry": {
                "Value": "IREC",
                "Description": "I-REC"
            },
            "FuelKind": "Biomass Solid: Forestry products",
            "FuelKindCode": "ES530",
            "FuelName": "Biomass",
            "FuelShortCode": "BMS"
        }
    ],
    "Meta": {
        "CurrentPage": 1,
        "TotalPage": 1,
        "TotalItems": 14,
        "ItemsPerPage": 100
    },
    "Errors": null,
    "StatusCode": 200,
    "Message": "Success"
}

Warning

400 Bad Request

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 400,
  "Errors": [],
  "Meta": null,
  "Message": "Bad Request"
}

Warning

401 Unauthorized

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 400,
  "Errors": [],
  "Meta": null,
  "Message": "Unauthorized"
}

Warning

403 Forbidden

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 403,
  "Errors": [],
  "Meta": null,
  "Message": "Forbidden"
}

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

  • Rate Limit: 3000 requests per 5 minute(s)

  • Renewal Period: 300 second(s)

  • Key: IP Address

  • Increment Condition: Any Request

Operation Policy

  • Rate Limit: 60 requests per 1 minute(s)

  • Renewal Period: 60 second(s)

  • Key: accound-id business account Id.

  • Increment Condition: Any Request

Rate Limit Details

  1. Rate Limit by Key:

    1. Key: This ensures that rate limits are applied uniquely for each business account id.

    2. Request Limit: Each key is allowed to make up to 60 requests per minute.

    3. Reset Interval: The limit resets every 60 seconds.

  2. Response Headers:

    1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

Example Response When Rate Limit is Exceeded

Code Block
languagejson
HTTP/1.1 429 Too Many Requests
Retry-After: 60
Content-Type: application/json

{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}