Oriental Wave's API is a RESTful API.
To gain access to our public API you must:
-
register as a standard user on the main website at the Registration URL
-
request access to the API at info@oriental-wave.com by including your username and your personal data
Do you have a suggestion? If you want to have a deeper integration with our services you can contact us at
info@oriental-wave.com to expand our API based on your suggestions.
Authentication
Each API call must be authenticated using the Authentication: Bearer [YOUR_AUTH_TOKEN] header.
Once you get access to the public API, the first thing you need to do to start making requests is to log in.
POST api/login (First Login)
Log in using your username and password
Body Parameters
| Name | Description | Type | Additional information |
|---|
| grant_type |
Use "password" when you are logging in with your username and password
|
string
|
None.
|
| username |
The username used to log in. You can use your username, your email or your FighterID.
|
string
|
None.
|
| password |
The password used to log in.
|
string
|
None.
|
Sample:
grant_type=password&username=user&password=pass
Response Informations
| Name | Description | Type | Additional information |
|---|
| access_token |
The access token to use when requests are made to the API
|
string
|
None.
|
| token_type |
Type of token generated. The value of this field is always "bearer".
|
string
|
None.
|
| expires_in |
The duration of the generated "acces_token". This value is indicated in seconds from the moment the token is generated.
|
integer
|
None.
|
| refresh_token |
The refresh token. This token is for single use and is used to recreate a new "access_token" without having to re-enter your username and password every time.
|
string
|
None.
|
Sample:
{
"access_token": "35ab05bb-8de9-4d0e-8df0-6d3663f5ab07",
"token_type": "bearer",
"expires_in": 1799,
"refresh_token": "c1ecd42b-40f9-416f-a9e5-3b8659ed9956"
}
POST api/login (Refresh Login)
If you have already logged in at least once, you can use a refresh token to be able to regenerate a new "access_token" without having to re-enter your username and password.
Body Parameters
| Name | Description | Type | Additional information |
|---|
| grant_type |
Use "refresh_token" when you are logging in using a refresh token.
|
string
|
None.
|
| refresh_token |
The refresh token used to regenerate the authentication token
|
string
|
None.
|
Sample:
grant_type=refresh_token&refresh_token=95a36943-2245-47ff-903d-01b59703839d
Response Informations
| Name | Description | Type | Additional information |
|---|
| access_token |
The access token to use when requests are made to the API
|
string
|
None.
|
| token_type |
Type of token generated. The value of this field is always "bearer".
|
string
|
None.
|
| expires_in |
The duration of the generated "acces_token". This value is indicated in seconds from the moment the token is generated.
|
integer
|
None.
|
| refresh_token |
The refresh token. This token is for single use and is used to recreate a new "access_token" without having to re-enter your username and password every time.
|
string
|
None.
|
Sample:
{
"access_token": "bde02962-ef41-4c77-86a9-25a42e9eb327",
"token_type": "bearer",
"expires_in": 1799,
"refresh_token": "41291296-81f6-4103-8225-f2b44678bcb3"
}
Quota
Each user who has access to our API has a certain amount of requests available that can be made monthly. This quantity, called from now on "Quota", is equal to 10,000 monthly requests.
Login operations are not counted within your "Quota".
If you need to extend your personal "Quota" contact us.
Attention! The "Quota" is for your account, so keep your username, password and authentication tokens safe to avoid Quota theft.
Public
Entry point for Oriental Wave's public API.
| API |
Description |
| GET api/Public/GetCardsDatabaseVersion |
Get the current version of the card database. Once you have obtained the current version of the card database, compare it with the one you have stored so as to check if there are updates to the database.
|
| GET api/Public/GetCardsDatabase?version={version} |
Download a copy of the card database. If the parameter is not specified, the entire card database is downloaded. If, on the other hand, the parameter is specified, only the changes made to the database from the specified version will be downloaded.
|
| GET api/Public/GetCardImage/{id} |
Download the image of the card with the given id
|
| GET api/Public/GetCardThumbnail/{id} |
Download the thumbnail image of the card with the given id
|
