HomeGuidesAPI ReferenceChangelog
Log InChangelog
Guides
Changelog
Start typing to search…

Access PSP APIs

Service paths and model definition for Access PSP.

What is Access PSP?

Access PSP is an application used to obtain an access token needed to use other Aera PSP services (psp.aerahost.com). By being authenticated using a valid clientId (username) and clientSecret (password), you’ll get an accessToken and a refreshToken back. The accessToken can then be used in the Authorization header as the Bearer token.

Figure 3. Sequence diagram for obtaining and using Access Token

Paths

Descriptions of resources/paths in the service.

Get Application Status (Health check)

GET /access/health

Parameters

Type

Name

Description

Schema

Header

Accept required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key required

The x-api-key header needed to get access to the API services.

string

Responses

HTTP CodeDescriptionSchema
200OKStatus

Produces

  • application/json

Tags

  • Health

Example HTTP request

GET /access/health HTTP/1.1
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Host: psp.aerahost.com

Example HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}

Example Curl request

$ curl 'https://psp.aerahost.com/access/health' -i -X GET \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json'

Introspects an access token - OAuth 2.0 Token Introspection

POST /access/v1/oauth2/introspect

Parameters

Type

Name

Description

Schema

Header

Accept required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type required

The content type of the body.

string

Header

x-api-key required

The x-api-key header needed to get access to the API services.

string

Query

introspectForm required

object

Responses

HTTP CodeDescriptionSchema
200OKIntrospectResponse

Produces

  • application/json

Tags

  • AccessPSP

Example GTTP request

POST /access/v1/oauth2/introspect HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Host: psp.aerahost.com
Content-Length: 746

token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA

Example HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: BgDJpbZvaBXtsjBOo1OvNs0XEsW0o+YwXzxrqgPcS3YyEo+rLLnGWQMadF8yDTrh6fkl9Fj3m7ywLQlBjUra0XhqNm5oobYpjdmW0VGJOT9jiTJizSHbh56/8qr0m+lYZjbGI7afNMtx21pi5kSexRzGjCAG3X6nUxwNt9KC/HI4I94AqNM+/LC8nL5pDPkf8mZWNWZDxxGUOFx+pRjOPk6sZXwdbR86tQCJkWxDpCyLbvVF0HVC/3LDI4MTqUJ2jViqESpiUPj0lcAUXhGGmhD87pk1CowU9yN8vYsBkgodFZ5MFlkHGZ5WEcuig+xwb/lbWR+k/QY4aQbsYE1+5g==
Content-Length: 240

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-02-24T10:07:22.992Z"
  },
  "active" : true,
  "sub" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "jti" : "0dfbe115-726e-4d2e-81c0-6bce08975eea",
  "exp" : 9999999999
}

Example Curl request

$ curl 'https://psp.aerahost.com/access/v1/oauth2/introspect' -i -X POST \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json' \
    -d 'token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA'

Create an access token

POST /access/v1/oauth2/token

Parameters

Type

Name

Description

Schema

Header

Accept required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type required

The content type of the body.

string

Header

x-api-key required

The x-api-key header needed to get access to the API services.

string

Body parameter

Responses

HTTPDescriptionSchema
201CreatedAccessResponse

Consumes

  • application/json

Produces

  • application/json

Tags

  • AccessPSP

Example HTTP request

POST /access/v1/oauth2/token HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Content-Length: 119
Host: psp.aerahost.com

{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}

Example HTTP

HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: AiA3wX0mchix3SBkwUXuwTyZ5BJIhSgISyirn0yh3afmOomfIZTs44QuPONuY8/ubPKELisfLiiDDdaUcP1oV1ZOgrTKEQ94jB5WurgHyf4GeCt407ly29Q21QmP7hXU3+uc+TH8DmOkK6L0EH6xCecGBZ6DjTJzpgZksRbod8ZrpHgd80G9pK3wLUw4GCE0aGvvBvRX1KUqyPBRpIVzbsoldxA13FnzqTZDDerFRz39mN6oAlYZzy4SNexv7h7nm2caWcAR5qts8gv2Wpgq1+q36UpAzegwF587cjnea9K3QthFU1uQif099jwFJAicaC515f5TXQkK13GyvplnRQ==
Content-Length: 1706

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-02-24T10:07:23.337Z"
  },
  "accessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIm50c0FsbCIsIm50c0ludGVybmFsQWxsIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6WyJhZXJhLnRlc3QtcmVzb3VyY2UiXSwibmJmIjoxNzQwMzkxNjQzLCJpYXQiOjE3NDAzOTE2NDMsImV4cCI6MTc0MDM5MjI0MywianRpIjoiN2ZkMDI1OTMtZWM4ZC00ZDIwLTkwNWUtZDA4MWJmZjgxY2VhIn0.fQZZJ_ZR8awuByOs_iRrQx_XDfi8JF06ORvN0vUCjpZvG930tQQyWSeNkTnnvN2vazZY5R5hCqjh5jZnnOh95gn43pTVQkYvZjYJfr3Z-2Btp63HHlSOjjGlFtY2_mv9yO62lXmyWa313J-U_jZQHM_tk9aiw00XrrLc4YW4RibcMuxand0SNfMmFi7POKbFi-AQRlY9mqLOSIKqjAz1e0w40bOsvUCjUyi5Hsmx9evalltS_WieeM-4HwCb8g59pwwVU8jgfosh2svs--w5IpYf8jclyuLtTXiFtYJ3JUDz9NSNbgTUgnAYh32VYh4IfyAnuwA7Fo3X_MCqm8an_g",
  "refreshToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJhdGkiOiI3ZmQwMjU5My1lYzhkLTRkMjAtOTA1ZS1kMDgxYmZmODFjZWEiLCJzdWIiOiIwNzdkMGU1NS1lNmM3LTQxZTQtOTE1Mi0xNWRlZWRlZjA4NDgiLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTc0MDM5MTY0MywiaWF0IjoxNzQwMzkxNjQzLCJleHAiOjE3NDAzOTU4NDMsImp0aSI6Ijg4Yjg2N2YyLTc3NjItNDI2Ni1hYWQ1LTA4YzkzYzRlYmYxNyJ9.klqXhl1F7QKa-9lJggTOKqdfbjYBcgCcnmZ0PCPWzmLPmd1247Gp0ygQtWSYk8bcPpeSH_nH0hJFcBh23E37b9oiymc971EV0lHBfZ8TwPmawmXGiPCGZd9qMqMY35i6V_2JqCJhk0UTtwTyPooaJVo6Z0X5Vl5bTygPy3g8YTDt_umRaDZgZPKRHcacKAjcMFWsE4ia_7jJtqewWBRE3HmyitAjVnEHY4MBVk2oSWf1lDJEMRHftgvOwm3qgMsHkhP5b0Ioh1sapsoCE8ri3fItKdddx79u2y1xb_Hv1RtM8gPfPLj4Mhxp1sVbX-1leOVTCWDXT87FVPLPhXlRlw",
  "expiresIn" : "600"
}

Example Curl request

$ curl 'https://psp.aerahost.com/access/v1/oauth2/token' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json' \
    -d '{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}'

Updated 2 months ago