We use cookies and similar technologies to process personal information for the operation of our website, statistical analysis, and providing targeted advertising. We share information about your use of the site with our advertising partners who may further share it with additional parties. You may opt out of performance cookies here, and learn more about how we use cookies here”
Search history
Clear
- Topics
- Release Information
- X-Sign Quick guide
-
X-sign User manual
- Account (4)
- License (4)
-
Manager (15)
- Pairing the device with X-Sign Manager
- Creating the channel
- Scheduling the content by channel
- Scheduling the content by device
- Editing the device management structure
- Pushing Real-Time Message to your BenQ Smart Signage remotely
- Controlling the device remotely
- Updating device Player remotely
- Managing the calling system
- Creating an API table in X-Sign Manager
- Setting Verification
- Getting the system notification
- Updating device status immediately New
- Player report (proof-of-play) New
- Using Designer Express New
-
Designer (18)
- Creating a new project file in X-Sign Designer
- Uploading your content from Designer
- Creating content in X-Sign Designer
- Creating content from Designed Templates
- Creating a clock widget in X-Sign Designer
- Setting a weather widget
- Creating an Image or Video slideshow
- Rotating an image or video
- Generating a QR Code
- Adding a data connection
- Setting a timer widget
- Creating an API template using the demo kit
- Creating a TV Input source widget in X-Sign Designer
- Setting background music in X-Sign Designer
- Changing the playing order of pages
- Sealing a file in X-Sign Designer
- Opening an X-Sign 1.x project file
- Changing your language in X-Sign Designer
- Player (6)
- Local Delivery (3)
- Report (2)
- Video Wall (3)
- Interactive (Premium) (6)
- API (Premium) (1)
- GPL/LGPL Software Licenses Used by X-Sign
- X-Sign OpenAPI
X-Sign OpenAPI
X-sign 2.0 / X-Sign OpenAPI
Authentication
2021 / 04 / 09
Overview of Authentication
When calling all X-Sign OpenAPI items, access_token must be included in the header. If this is not included, a "401 Unauthorized" error will be returned.
An obtained token expires and becomes unavailable for use after ONE MONTH. If this is the case, you should obtain a new token.
The process is as follow:
1. call the API to get access_token
2. redirect to auth server (login page)
3. end-user login (admin account only)
4. redirect to request.redirect_uri with access_token
access_token can be obtained by calling the following api.
Auth flow
The authorization is similar to the OAuth 2.0 authorization code flow, with one important distinctions :
The response_type parameter must include external_token.
Auth URL
https://service-portal.benq.com/external/{version}/{path}
Version
v1
Auth API
GET /oauth/authorize
Request Parameter
| Name | Schema | Description |
Name client_id | Schema Required. Type: integer | Description client_id |
Name redirect_uri | Schema Required. Type: string | Description redirect_uri (Must be the same as the registered value) |
Name response_type | Schema Required. Type: string Value:external_token | Description response_type |
Name scope | Schema Optional. Type: string Value:xsign | Description scope |
Name state | Schema Optional. Type: string | Description request state |
curl -X GET "/external/v1/oauth/authorize"
-d '{
"client_id":3,
"redirect_uri":"http://example.com/callback",
"response_type":"external_token",
"scope":"xsign"
}'
Response Code
General HTTP Staus Code
| Code | Description |
Code 302 | Description Found, Redirect |
Final Response Header (redirect_uri)
URL redirect to request.redirect_uri
| Key | Schema | Description |
Key *Location | Schema string | Description request.redirect_uri with parameters |
Final.Response.Header.Location.parameters (auth SUCCESS)
| Key | Schema | Description |
Key *access_token | Schema string | Description access_token |
Key *token_type | Schema string Value:bearer | Description token type |
Key *expires_in | Schema integer | Description expired (second) one month |
Key *state | Schema string | Description request state |
Final.Response.Header.Location.parameters (auth ERROR)
| Key | Schema | Description |
Key *error | Schema string Value:access_denied|invalid_scope | Description token type |
Key *state | Schema string | Description request state |
Location: http://clientapi.com.tw#access_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjM5NmI2ZTQ0OTFjNDU0YTBhYzBjMzM1MDAyYTUzOTFkNDRhMWM1YzkwYTkxYzdiZmEyMTJlYTIxZjc5M2ZkOGY5ZGRiMmJiYWRmMDdhODYxIn0.eyJhdWQiOiIzIiwianRpIjoiMzk2YjZlNDQ5MWM0NTRhMGFjMGMzMzUwMDJhNTM5MWQ0NGExYzVjOTBhOTFjN2JmYTIxMmVhMjFmNzkzZmQ4ZjlkZGIyYmJhZGYwN2E4NjEiLCJpYXQiOjE1Nzc0MTY1NDMsIm5iZiI6MTU3NzQxNjU0MywiZXhwIjoxNTc3NDIzNzQzLCJzdWIiOiIxMDAxIiwic2NvcGVzIjpbXX0.txBx2sOPrnJomcrx27ibgPPOIm21VcjcAxb3upNMZYiXzyo59y9gTVrGw_u442w0pyaRsXDVlhmS6K9RCfykswd4cAlSdfR9gFQRhEqNwSak8XkZBjVxT7818m8Z9R_jcAVvvlMC3Gz0fhLCKmuNhQSs4On8NQBW4KSewSYYoL25h_Gtl5C7G4XneLoCqIqLY3JyXcr8-LTzbn-GWrwGNsPeRoQQyVki4Uc89RoYhnp4-n8GQFMJuaOettaKNyu5qpP04-q6xMPYvMM5PBtTgj-4dYsxIBe51HbnpMYglgccOTt3iTx0EOsCefKY54tyKT38z8bCV9YeQ9Pwe_QXPocaEgWSAkYpBCzt6ZdoUWX3GDuXQxzyO_OCioQU_ipB3FWSrfdWjfJi4b2YelUs5oC_AUNPdam2tY8bg68x4oGWCXiCi_s7bPegUuyGSf3CUjmR2HZc5rbWYS1JNct7Xp4-k4poxwlhOF3EDy5jWmSDVykrigjkWjwFT2bDLk4rtN2l4W_OliVbyiAmp78fwwEKjh1vSrW9UpfMWoMrHX4eEa1Ca96WNr4oJOeugxCPPzBzJZF5TBxPhPcn3wd0fL7iPNUS1lr3byJsHMpMADDdNvEacS8e-k9Y7Rt5q-xl7-OoymH9IPaPRY3KL7FhhcG3zFnRt4rGLD7xgM&token_type=bearer&expires_in=7200
Your Local Office
BenQ America Corp.
5741 Legacy Dr #210, Plano, TX 75024, USA
Tel: 888-818-5888
Fax: +1-214-473-9998
Follow Us
Ⓒ2020 BenQ - all rights reserved.
TOP