POST /api/login/appLogin

Validates the AppID and Shared Secret associated with a specific app.

Authorization Roles/Permissions: Login is not required.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/login/appLogin

Back to top

Sample Request

The example below shows a login request for a specific app.

Request URL

https://{hostname}/api/login/appLogin?appID=acmepaymentscorp-w1jHSwRV1RvPeWs5NB2wUHNP6GKCvi78SsVbBQpb&secretKey=7331d4b4c7622dfe5c204307376e75be03d68b2bbb23830dab46c019ea41c5e5

Sample request headers

Content-Type: application/x-www-form-urlencoded
Accept: text/plain

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept text/plain
Content-Type application/x-www-form-urlencoded

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
appID Query AppRuntimeID Required The App Runtime ID. Note that this is in the format tenant.{ID}, not the AppID which is in the format {ID}.{tenant}. Example: acmepaymentscorp-w1jHSwRV1RvPeWs5NB2wUHNP6GKCvi78SsVbBQpb
secretKey Query string Required The app's Shared Secret. In the developer portal, the ID and shared secret are in the App Details page, in the Security section.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Back to top

Sample Response

The sample response below shows successful completion of this operation; the app credentials are correct and have been validated. The response is HTTP 200 with no content for valid credentials, HTTP 401 for invalid credentials.

Sample response headers

date:  Thu, 21 Jun 2018 19:03:08 GMT

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

None.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. You would get this response for this operation if either of the parameters had an incorrect value.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics