GSS User API
The GSS User API is used to obtain the sellerId
that is used for user authentication with the GSS Metric API (GSS is the acronym for Galaxy Store Statistics).
The GSS User API is part of the Galaxy Store Developer API. You must meet all of the requirements of the Galaxy Store Developer API including, but not limited to, creating the access token and including the access token in the authorization header of every GSS User API call.
Authorization header parameters
Every request must include authorization header parameters which specify the content type, your access token, and cookie values after logging in to Seller Portal. See Create an Access Token for more information about how to create an access token and Use the Access Token for more information about how to use the access token.
Name | Type | Description |
---|---|---|
Authorization | string | Required. Use Bearer <your-access-token> where <your-access-token> is the access token you requested from the Galaxy Store authentication server
|
content-type | string | Required. Must be application/json
|
service-account-id | header | Required. The service account ID used to create the JWT associated with the access token (can be found in the Assistance > API Service area of Seller Portal) |
api_server_url | string | Required. See Get cookie values for more information on how to obtain this value. |
auth_server_url | string | Required. See Get cookie values for more information on how to obtain this value. |
gss_auth_token | string | Required. See Get cookie values for more information on how to obtain this value. |
sellerLocale | string | Required. See Get cookie values for more information on how to obtain this value. |
Get cookie values
Four cookie values are needed as part of the user request. You must be logged in to Seller Portal to obtain these values.
Chrome
- Log in to Seller Portal.
- Open the Developer Tools (press F12 or select More tools > Developer tools).
- From the top menu (you may need to select >> to view the menu), select Application.
- Under Storage, expand the Cookies node and select https://seller.samsungapps.com.
- Locate the attributes and copy the values.
Firefox
- Log in to Seller Portal.
- Open the Firefox Developer Tools (press F12 or select Web Developer > Storage Inspector).
- If not already opened, go to the Storage tab.
- From the left pane, expand the Cookies node and select https://seller.samsungapps.com.
- Locate the attributes and copy the values.
Login user profile
Get the sellerId
for GSS metric API user authentication.
Request
POST /gss/user/loginUserProfile
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your-access-token>" \
-H "service-account-id: <your-service-account-id>" \
-H "Cookie:sellerLocale=<your-seller-locale>; gss_auth_token=<your-gss-auth-token>; api_server_url=<your-api-server-url>; auth_server_url=<your-auth-server-url>" \
"https://devapi.samsungapps.com/gss/user/loginUserProfile"
Response
The value assigned to the sellerInfo: {gssUserId}
attribute is used for the value of sellerId
in the sellerMetric request.
-
Success
Status: 200 Success
{ "data": { "hashedUserId": "abcde12345zyxwv09876fedcba34567", "sellerLocale": "ko_KR", "geoIp": { "city": { "confidence": null, "geoname_id": 1835553, "names": { "de": "Suwon", "ru": "Сувон", "ja": "水原市", ... } }, "continent": { "code": "AS", "geoname_id": 6255147, "names": { "de": "Asien", "ru": "Азия", "pt-BR": "Ásia", ... } }, "country": { "confidence": null, "geoname_id": 1835841, "is_in_european_union": false, "iso_code": "KR", "names": { "de": "Südkorea", "ru": "Южная Корея", "pt-BR": "Coreia do Sul", ... } }, "location": { "accuracy_radius": 1000, "average_income": null, "latitude": 37.2859, "longitude": 127.0099, "metro_code": null, "population_density": null, "time_zone": "Asia\/Seoul" }, "maxmind": { "queries_remaining": null }, "postal": { "code": "16258", "confidence": null }, "registered_country": { "confidence": null, "geoname_id": 1835841, "is_in_european_union": false, "iso_code": "KR", "names": { "de": "Südkorea", "ru": "Южная Корея", "pt-BR": "Coreia do Sul", "ja": "大韓民国", "en": "South Korea", "fr": "Corée du Sud", "zh-CN": "韩国", "es": "Corea del Sur" } }, "represented_country": { "confidence": null, "geoname_id": null, "is_in_european_union": false, "iso_code": null, "names": {}, "type": null }, "subdivisions": [ { "confidence": null, "geoname_id": 1841610, "iso_code": "41", "names": { "en": "Gyeonggi-do", "zh-CN": "京畿道", "ja": "京畿道" } } ], "traits": { "autonomous_system_number": null, "autonomous_system_organization": null, "connection_type": null, "domain": null, "ip_address": "000.00.00.00", "is_anonymous": false, "is_anonymous_proxy": false, "is_anonymous_vpn": false, "is_hosting_provider": false, "is_legitimate_proxy": false, "is_public_proxy": false, "is_residential_proxy": false, "is_satellite_provider": false, "is_tor_exit_node": false, "isp": null, "network": "000.00.00.0\/00", "organization": null, "user_type": null, "user_count": null, "static_ip_score": null } }, "ip": "000.00.00.00", "sessionId": "abcdef1234567890zyxwvu1234567890", "isAdmin": true, "isOnlyInstant": false, "userID": "abcdefg123", "ttl": 1615959526, "userBaseVO": { "userDisplayName": "jeff" }, "sellerInfo": { "privilegeCode": "general", "gssUserId": "abcdefg123", "countryCode": "KOR", "languageCode": "en_US" }, "csrfToken": "1234567890abcdef01234567890abcdef", "hasValidCsrfToken": true, "sessionCreationTime": 1615959247823, "isTrustedIp": true, "userIdentificationVO": { "loginID": "xxxxxxxx.xxx@gmail.com" }, "authServerUrl": "xxx.samsung.com" } }
-
Failure: Payload is not a valid json
Status: 400 Payload is not a valid json
-
Failure: Unauthorized exception
Status: 401 Unauthorized exception. Please login from Galaxy Store Seller Office.
-
Failure: Server Internal Error
Status: 500 Server Internal Error