Product Management

Register a new product and receive the unique product registration key

Good to know: These services are not provided for a developer to use in-game. Please log into your developer dashboard at www.gaimin.tech

Register Product

Auth: None

Register Product

POST https://api.gaimin.gg/api/public/v1/product

Allows developer to register a new product and returns the unique product API key.

Headers

Name	Type	Description
accept*	String	*/*
Content-Type*	String	application/json

Request Body

Name	Type	Description
contactEmail*	String	Contact email address 3..300
companyName*	String	Name of company 2..100
companyDescription	String	Company description 10..2000
description	String	Product description 10..2000
website	String	Company website
name*	String	Product name 2..100

200: OK apiKey

Example Request:

curl --location 'https://api.qa.gaimin.gg/api/public/v1/product' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "example product name",
    "description": "example product description",
    "contactEmail": "[e-mail]",
    "companyName": "example company name",
    "companyDescription": "example product string",
    "websiteLink": "https://en.wikipedia.org/wiki/Coat_of_arms_of_Ukraine"
}'

Example Response:

{
  "data": {
    "apiKey": "8dcaa202-7048-4c19-a30c-f7c7a9e5658c"
  },
  "success": true
}

Retrieve Product Information

Auth: PRODUCT

Obtain Product Information

GET https://api.gaimin.gg/api/public/v1/product

Obtain previously registered product information

Headers

Name	Type	Description
accept*	String	*/*
X-Api-Key*	String	apiKey

Request Body

Name	Type	Description
none	String

200: OK productDto

<productDto>
- name
- description
- contactEmail
- companyName
- companyDescription
- website

Example Request:

curl --location -g 'https://{{gaimin_link}}/api/public/v1/product' \
--header 'accept: */*' \
--header 'X-Api-Key: 8dcaa202-7048-4c19-a30c-f7c7a9e5658c'

Example Response:

{
  "data": {
    "name": "example product name",
    "description": "example product description",
    "contactEmail": "[e-mail]",
    "companyName": "example company name",
    "companyDescription": "example product string",
    "websiteLink": "https://en.wikipedia.org/wiki/Coat_of_arms_of_Ukraine"
  },
  "success": true
}