Assets Server REST API - API login – Home

/services/apilogin

What does it do?

Before being able to request information from Assets Server by using a GET request or make changes to the system through a POST request by using any of the REST APIs, a log in to Assets Server is required.

The REST API - API login provides the process of logging into the system and is typically used for external integrations. It allows multiple sessions and an API User license. It returns an authentication cookie which can then be used for future POST requests. It cannot be used within Assets in the Web browser.

Notes:

Although it is technically possible to use this call to mimic the behavior of a client application, it is not allowed to mask clients. APIs and API licenses are only allowed to be used to automate tasks.

This API is aimed at pure API clients and cannot be called from a Web browser.

To perform this call it is advised to use a user with an API license. This way, multiple API sessions are allowed.

Using this API makes it easier to create integrations than its alternative the REST API - Login which is typically used for internal plug-ins such as action plug-ins and panel plug-ins that are used within Assets in the Web browser. It authenticates the Web browser session and returns a CSRF token which can then be used for future POST requests.

Parameters

username

The user name of the user.

Required.

password

The password of the user.

Required.

clientId

Tracks the check-out of an asset to a specific client. Only that client will be able to check in the asset.

Typically a client will generate a UUID once, store it locally and then pass it with every log-in action. When not specified, client check-outs will not be tracked with a client id.

Optional, only required when your client performs check-outs and check-ins.

Return value

The service returns a JSON response with the following information:

loginSuccess

true | false

Indicates if the log-in action was successful.

serverVersion

The version of Assets Server that was logged in to.

loginFaultMessage

A message indicating why a log-in action failed. Only returned when loginSuccess is false.

authToken

Authentication token. This token should be attached to each next call in the "Authorization" header with "Bearer" type for any next GET or POST calls. A CSRF token is not required in this case.

Only returned when loginSuccess is true.

Example: A request with an Authorization header:

Authorization: Bearer

eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNp8U9luozAU_Rc_52FmmmZo3hy4JZ6AbdkmXUaVRVuiQSIkwyJNVfXfa0NZIw1PcO52zrmXd1TWz2iN4tdjmqMFesnSJK_U2zkxIOakh8grWud1li1Q_nxA6-9Lx7m5vl79cBYo-XdOizeVHm3N1eqbfUxdkfx1y8LkHuKsTBaoLpPiqzEvTqip6xrdXC2dNsNLqjjNSrR-R3FdofVvJFgAWkYcRCRBmLoGwERoNyBAVYc00SfDtyqtoHNqRxzjjnadxyOdcW54VEVteCU20L6-DOihzifpWRv4WKA0rnr9Py1tw_OPtQetVvtf5cnhOyw3ZFkuncdU1hy1GacirdKkHBRtsTCkecCw14tyFWFU8yDyCZVjYeqBg25tazC-ZYrJLeMzE-CeM6G0dKFDQkyxbwpAhERK015eRiQHM3kPfcjdgrtjUd-WhDbTFBAeBdiSnDeZUv5CJUwneuyOjvVKvAfPZGFhBsqxC3usJsz6isY1zLlgA-hGUrGwc8-DTeTPQlwQqrTLqDJJpgnA9Gy67gor-d8L8zTppSt8zygLH_pqoJ6GEJNgsM1uozeFbYildHG1-pHRQYwhaeINFytnmk6oB5L4c_gW75kgavCw9UkYRqQ9KQES1MUiNO4hAa6xVAyfPlAQdg1qG4UbOpLlYYU19kIyv4KWlJVwS_wJle7DTJhcxMV_3V2OLfJ0QOiuz72DzUy2y4IAmq1L9PTxCQAA__8.l-60WwZyLImpXPlqjsJhfH6y5Mltk1FZtSOd3riDrgB7a7zmVCCN9RSsX1ixLC9NZ6_0rMgL2dChTLZB4WqrvA

Examples

Successful login

The following shows the response of a successful authentication attempt.

POST

http://demo.assets-server.com/services/apilogin    
    ?username=api
    &password=api

{
  "loginSuccess": true,
  "serverVersion": "6.3.0.1",
  "authToken": "eyJhbGciOiJIUzUxMiIsInppcCI6IkRFRiJ9.eNp8U9luozAU_Rc_52FmmmZo3hy4JZ6AbdkmXUaVRVuiQSIkwyJNVfXfa0NZIw1PcO52zrmXd1TWz2iN4tdjmqMFesnSJK_U2zkxIOakh8grWud1li1Q_nxA6-9Lx7m5vl79cBYo-XdOizeVHm3N1eqbfUxdkfx1y8LkHuKsTBaoLpPiqzEvTqip6xrdXC2dNsNLqjjNSrR-R3FdofVvJFgAWkYcRCRBmLoGwERoNyBAVYc00SfDtyqtoHNqRxzjjnadxyOdcW54VEVteCU20L6-DOihzifpWRv4WKA0rnr9Py1tw_OPtQetVvtf5cnhOyw3ZFkuncdU1hy1GacirdKkHBRtsTCkecCw14tyFWFU8yDyCZVjYeqBg25tazC-ZYrJLeMzE-CeM6G0dKFDQkyxbwpAhERK015eRiQHM3kPfcjdgrtjUd-WhDbTFBAeBdiSnDeZUv5CJUwneuyOjvVKvAfPZGFhBsqxC3usJsz6isY1zLlgA-hGUrGwc8-DTeTPQlwQqrTLqDJJpgnA9Gy67gor-d8L8zTppSt8zygLH_pqoJ6GEJNgsM1uozeFbYildHG1-pHRQYwhaeINFytnmk6oB5L4c_gW75kgavCw9UkYRqQ9KQES1MUiNO4hAa6xVAyfPlAQdg1qG4UbOpLlYYU19kIyv4KWlJVwS_wJle7DTJhcxMV_3V2OLfJ0QOiuz72DzUy2y4IAmq1L9PTxCQAA__8.l-60WwZyLImpXPlqjsJhfH6y5Mltk1FZtSOd3riDrgB7a7zmVCCN9RSsX1ixLC9NZ6_0rMgL2dChTLZB4WqrvA"
}

Login failure

The following shows the response of a failed authentication attempt.