Allow user to get their accounts information

Changelogs

Version	Date	Changes by	Description of change
V1.0	24 Oct 2024	Tam Tran	Added Table of Contents. Added Changelogs.

Account Resource

Id guid

Id Uniquie Identifier

ReferralCode text

Referral Code

AccountType object

Value: Value of Enum
Description: Description of Enum

Payment Type (Normal, Premium)

EvidentTradeAccount text

Evident Trade Account

CompanyInfo[CompanyName] text

Company Name

CompanyInfo[CompanyEnglishName] text

Company English Name

CompanyInfo[CompanyRegistrationNumber] text

Company Registration Number

CompanyInfo[Address] text

Company Address

CompanyInfo[Country] text

Company’s country

CompanyInfo[Province] text

Company’s province

CompanyInfo[Email] text

Company’s email

CompanyInfo[ContactNumber] text

Company’s contact number

ContactPerson[FirstName] text

Contact’s first name

ContactPerson[LastName] text

Contact’s last name

ContactPerson[JobTitle] text

Contact’s job title

ContactPerson[Email] text

Contact’s email

ContactPerson[Country] text

Contact’s country

ContactPerson[PostalCode] text

Contact’s postal code

ContactPerson[City] text

Contact’s city

ContactPerson[Address] text

Contact’s address

Code Block

language	json

{
  "Id": "64ec3591-b4e4-4253-1beb-08db3efdd2f5",
  "ReferralCode": null,
  "AccountType": {
    "Value": "Normal",
    "Description": "Normal"
  },
  "EvidentTradeAccount": "CPHGJRY5",
  "CompanyInfo": {
    "CompanyName": "Nam Song Tien Company",
    "CompanyEnglishName": "Nam Song Tien Company",
    "CompanyRegistrationNumber": "NST06NVT",
    "Address": "180 D. Nguyễn Văn Trỗi, Phường 8, Phú Nhuận, Thành phố Hồ Chí Minh",
    "Country": "Viet Nam",
    "Province": "Lai Châu",
    "Email": "quenam.nguyen@trecssongn@com.sgvn",
    "ContactNumber": " "
  },
  "ContactPerson": null {
    "FirstName": "John",
    "LastName": "Doe",
    "JobTitle": "Solar Developer",
    "Email": "tamZZZ@com.vn",
    "Country": "Vietnam",
    "PostalCode": "700000",
    "City": "TPHCM",
    "Address": "180 D. Nguyễn Văn Trỗi, Phường 8, Phú Nhuận, Thành phố Hồ Chí Minh"
  }
}

API Definition

Status

colour	Green
title	GET

public/v2/profile

Request

Headers

Content-Type	`application/json`
Authorization	`Bearer {{access_token}}`

Query Parameters

Code Block
curl --location 'https://uat-api.redex.eco/public/v2/profile' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {{access_token}}'

Response

Response Body

Data object collection - Account Resource

A collection of objects - Account 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, 400, 422.

http状态码，如200，201，400, 422

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info
200 Success

Code Block

language	json

{
  "Data": [     {
      "Id": "64ec3591-b4e4-4253-1beb-08db3efdd2f5",
 
    "ReferralCode": null,
 
    "AccountType": {
 
      "Value": "Normal",
 
      "Description": "Normal"
      },
 
    "EvidentTradeAccount": "CPHGJRY5",
      "CompanyInfo": {
 
      "CompanyName": "Nam Song Tien Company",
 
      "CompanyEnglishName": "Nam Song Tien Company",
 
      "CompanyRegistrationNumber": "NST06NVT",
 
      "Address": "180 D. Nguyễn Văn Trỗi, Phường 8, Phú Nhuận, Thành phố Hồ Chí Minh",

       "Country": "Viet Nam",
        "Province": "Lai Châu",

       "Email": "quenam.nguyen@trecssongn@com.sgvn",
 
      "ContactNumber": " "
 
    },
      "ContactPerson": null
    },
    {
      "IdFirstName": "57b702b5-caba-432e-7233-08dce274c1e9John",
      "ReferralCode": null,
      "AccountType": {
        "Value": "Normal",
LastName": "Doe",
       "DescriptionJobTitle": "Normal"
      }Solar Developer",
      "EvidentTradeAccountEmail": "C3URNNHWtamZZZ@com.vn",
      "CompanyInfoCountry": {
        "CompanyName": "PJVI Oil Energy",
Vietnam",
       "CompanyEnglishNamePostalCode": "PJVI Oil Energy700000",
 
      "CompanyRegistrationNumberCity": "CP903232321fd433TPHCM",
        "Address": "1180 Le Duan",
        "Country": "Viet Nam",
        "Province": "An Giang",
        "Email": null,
        "ContactNumber": "+84 932174322"
 D. Nguyễn Văn Trỗi, Phường 8, Phú Nhuận, Thành phố Hồ Chí Minh"
    },
      "ContactPerson": null
 
  }
  ],
  "Meta": {
    "CurrentPage": 1,
    "TotalPage": 1,
    "TotalItems": 2,
    "ItemsPerPage": 100
  }null,
  "Errors": null,
  "StatusCode": 200,
  "Message": "Success"
}

Warning
400 Bad Request

Code Block

language	json

{
  "Data": null
  "StatusCode": 400,
  "Errors": null,
  "Meta": null,
  "Message": "Bad Request"
}

Warning
422 Unprocessable Entity

Code Block

language	json

{
  "Data": null
  "StatusCode": 402,
  "Errors": null,
  "Meta": null,
  "Message": "Unprocessable Entity"
}

Warning
401 Unauthorized

Code Block

language	json

{
  "Data": null,
  "StatusCode": 401,
  "Errors": null,
  "Meta": null,
  "Message": "Unauthorized"
}

Warning
403 Forbidden

Code Block

language	json

{
  "Data": null,
  "StatusCode": 403,
  "Errors": null,
  "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: 10 requests per 10 seconds(s)
Renewal Period: 10 second(s)
Key: accound-id business account Id.
Increment Condition: Any Request.

Rate Limit Details

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 10 requests per 10 seconds.
3. Reset Interval: The limit resets every 10 seconds.
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

language	json

HTTP/1.1 429 Too Many Requests
Retry-After: 10
Content-Type: application/json
{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}

Version	Old Version 3	New Version Current
Changes made by	Que Nguyen	Que Nguyen
Saved on	Nov 28, 2024	Dec 04, 2024

Page Comparison

Versions Compared

Key

Table of Contents

Changelogs

Account Resource

API Definition

Request

Headers

Query Parameters

Response

Rate limit

Rate Limiting Overview

Global Policy

Operation Policy

Rate Limit Details

Exceeding the Rate Limit

Example Response When Rate Limit is Exceeded