Service Authentication API

Generate access token using API secret Key

Register your service on Entity Studio Developer Dashboard and generate your API secret Key before proceeding.

Once the API secret key is generated, you can use the API below to generate a new access token. Just pass your API secret Key in X-Api-Secret-Key header to generate access token. The access_token is required to access all SSI APIs. Read the next section for more details.

Entity Studio SSI API base URL: https://api.entity.dashboard.hypersign.id/

POST/api/v1/app/oauth

Header parameters

Response

200400401

AccessToken generated

Body

application/json

access_token*string

accessToken

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjRkNjhmMjNmLTcwZjQtNDFhZC1hMGViLTU3MjA4YTZlOTcxMSIsImFwcFNlY3JldCI6IjNjN2NiNTY1LTZmNWQtNGY2MC1hMjQ2LTZhOGFjYWVhMmY0MyIsImdyYW50VHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsImlhdCI6MTY3NDAyMDY3NCwiZXhwIjoxNjc0MDM1MDc0fQ.P-AbheTJMxQNGLTkGWOsnct4M0nKCd-7oUFGqMCpIDM"

tokenType*string

Type of token

Example: "Bearer"

expiresIn*number

Token expiry time

Example: 14400

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/app/oauth', {
    method: 'POST',
    headers: {
      "X-Api-Secret-Key": "text"
    },
});
const data = await response.json();

Response

200400401

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjRkNjhmMjNmLTcwZjQtNDFhZC1hMGViLTU3MjA4YTZlOTcxMSIsImFwcFNlY3JldCI6IjNjN2NiNTY1LTZmNWQtNGY2MC1hMjQ2LTZhOGFjYWVhMmY0MyIsImdyYW50VHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsImlhdCI6MTY3NDAyMDY3NCwiZXhwIjoxNjc0MDM1MDc0fQ.P-AbheTJMxQNGLTkGWOsnct4M0nKCd-7oUFGqMCpIDM",
  "tokenType": "Bearer",
  "expiresIn": 14400
}

Once you generated the accessToken, you can pass this token as bearer authorization token in the header for all APIs.

Generate AccessTokens