Connect ZEPETO account through API
ZEPETO ID is required to create an Avatar Image. You can connect ZEPETO account through API. Please refer to the steps below.
How to connect ZEPETO account
Get ZEPETO QR code Log-in URL
This is an API that generates QR data for ZEPETO QR login.
You can create a QR code using the url of the response body.
The url and sessionId of the response body are only valid for 60 seconds.
POST https://api.render-it.m2s.team/services/biz/characters/authHeader parameters
| Key | Description | Example |
|---|---|---|
authorization | Enter the Token created in ZEPETO Render-it. Bearer authentication is used. | Bearer {ENTERPRISE_TOKEN} |
Example
curl -i -X POST \
-H "Authorization:Bearer {ENTERPRISE_TOKEN}" \
'https://api.render-it.m2s.team/services/biz/characters/authResponse Body
| Key | Description | Type | Example |
|---|---|---|---|
url | Data of the QR code to be created. | String | ZEPETO://PLATFORM/QR_LOGIN?url=https://admin-api.render-it.m2s.team&api=/activate/characters&udid=JuwqDHw7R3GnJIht7tWFNelLQ8G_42GR |
sessionId | Key value for managing the series of processes that connect ZEPETO account. | String | JuwqDHw7R3GnJIht7tWFNelLQ8G_42GR |
Determine whether ZEPETO Log-in was successful
This is an API that allows you to determine whether the application user has successfully logged in to ZEPETO through the generated QR code.
GET https://api.render-it.m2s.team/services/biz/characters/auth/{SESSION_ID}Header parameters
| Key | Description | Example |
|---|---|---|
authorization | Enter the Token created in ZEPETO Render-it. Bearer authentication is used. | Bearer {ENTERPRISE_TOKEN} |
Query parameters
| Key | Description | Required |
|---|---|---|
sessionId | Key value for managing the series of processes that connect ZEPETO account. | Yes |
Example
curl -i -X GET \
-H "Authorization:Bearer {ENTERPRISE_TOKEN}" \
'https://api.render-it.m2s.team/services/biz/characters/auth/{sessionId}Response Body
| Key | Description | Type | Example |
|---|---|---|---|
result | Value indicating whether login was successful or not. | Boolean | false |
Connect ZEPETO account
This is an API that registers an account after ZEPETO Log-in is completed.
The zepetoId and friendZepetoIds of the registered account can be used when creating an Avatar Image.
POST https://api.render-it.m2s.team/services/biz/charactersHeader parameters
| Key | Description | Example |
|---|---|---|
authorization | Enter the Token created in ZEPETO Render-it. Bearer authentication is used. | Bearer {ENTERPRISE_TOKEN} |
Body parameters
| Key | Description |
|---|---|
sessionId | Key value for managing the series of processes that connect ZEPETO account. |
Example
curl -i -X POST \
-H "Authorization:Bearer {ENTERPRISE_TOKEN}" \
-H "Content-Type:application/json" \
-d \
'{
"targets": [
{
"sessionId": "{SESSION_ID}"
}]
}' \
'https://api.render-it.m2s.team/services/biz/characters'Response Body
| Key | Description | Type | Example |
|---|---|---|---|
sys.id | An identification value for the connected ZEPETO account. | String | IrhQ8sj0uVZY6eX0y6eN1Dxg5TjIpmdy |
sys.zepetoId | ZEPETO ID of the connected ZEPETO account. | String | zepeto |
sys.friendZepetoIds | Friends' ZEPETO Id of the connected ZEPETO account. | String[] | [] |
Disconnect ZEPETO account
This is an API for disconnecting ZEPETO account. It may be used when the connection is no longer needed or for purposes of managing usage.
DELETE https://api.render-it.m2s.team/services/biz/characters/{CHARACTER_ID}Header parameters
| Key | Description | Example |
|---|---|---|
authorization | Enter the Token created in ZEPETO Render-it. Bearer authentication is used. | Bearer {ENTERPRISE_TOKEN} |
Query parameters
| Key | Description | Required |
|---|---|---|
characterId | Code to determine Avatar Image quality. | Yes |
Example
curl -i -X DELETE \
-H "Authorization:Bearer {ENTERPRISE_TOKEN}" \
'https://api.render-it.m2s.team/services/biz/characters/{CHARACTER_ID}'Auto-Disconnect ZEPETO account
We provide a function to automatically disconnect ZEPETO account after a certain period of time.
This setting is automatically set when Enterprise is activated, and can be modified as follows.
- Go to the Enterprise page.
- Go to the Setting page.
- Click Edit.
- Change Default Disconnect Time and click Edit.
Errors
When connection ZEPETO account, errors may occur in various situations. The user may have entered incorrect data, or it may be an ZEPETO Render-it service failure. Please refer to the table below for simple information and solutions.
| Error code | Description | Solution |
|---|---|---|
401 | Not a valid Token | Please check if there is a typo in the Token and whether the values match. |
403 | Quota reached or exceeded | Please check if exceeds resource limit or disconnect unuse ZEPETO account. |
404 | Not a valid value | Please check if the entered value are correct. |
500 | ZEPETO Render-it service failure | Please contact support team. |