Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titlev1.1
 

...

curl -d "" -H "code:<your user API authorization code>" "https://<your inspera domain>/api/authenticate/token/ ?grant_type=authorization_code&client_id=<your client_id>"


All the APIs assume a base url in the following format:

https://<your inspera domain>/api 

In this table you will find key values for API authentication:


Value

URL

/api/authenticate/token/

Method

POST

URL Parameters:

*required


grant_type*

authorization_code

client_id*

(string), please see above for more details on how to obtain this information)

HEADER Parameters:

*required

code*

(string)

Data Parameters:

(required for POST)


Content-Type

application/x-www-form-urlencoded

Responses:


200

Success

Returns: 

{
    "access_token": string,
    "expires_in": integer
}

400

Error: Bad request

Returns:

{

    "error": [OAuth2Exception]

}

401

Error: Unauthorized

Returns:

{

    "error": "invalid_grant"

}

409

Error: Conflict

Returns:

{

    "error": "Multiple tokens for user",

    "description": "Please contact inspera support"

}

500

Error: Internal server error

Returns:

{

    "error": "Internal error authenticating user",

    "description": "Please contact inspera support"

}

501

Error: not implemented

...

In this example, API call is made to export results for a learner on a given test using this

Jira Legacy
showSummaryfalse
serverSystem JIRA
serverIde54d9d57-478f-3f2a-9602-7dc7efa734f9
keyIB-1250
API: https://ia.inspera.no/apidoc/#/candidates/getCandidateResult

...