POST /api/users/{UserID}/topapis

Adds an API to a user's Top APIs list.

Valid in version: 2020.1.0 and later.

Authorization Roles/Permissions: Must be logged in. Only the current user can perform this operation, for himself/herself.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/{UserID}/topapis

Sample Request

The example below shows an example of a user adding an API to the user's Top APIs list.

Sample Request URL

https://{hostname}/api/users/68d00189-e080-4aba-891a-923588137f6e.acmepaymentscorp/topapis

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "APIID":"e2ff67fd-6d8b-47c5-a097-b8c36fc74c09.acmepaymentscorp"
}

Request Headers

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

Header	Description
Accept	application/json, application/vnd.akana.v2020+json
Content-Type	application/json, application/vnd.akana.v2020+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
userTopApi	Body	userTopApi	Required	Contains information about an API that a user has chosen as a Top API. Only the APIID is sent in the request body. See example.

Response

If successful, this operation returns HTTP status code 200, with information about the API that was added to the user's Top APIs list.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 16 Jun 2020 01:04:43 GMT

Sample response body: application/json

{
  "APIID": "APIID":"e2ff67fd-6d8b-47c5-a097-b8c36fc74c09.acmepaymentscorp",
  "ApiName": "Sales API",
  "AvatarURL": "http://opencloud-acmepaymentscorp.com/api/apis/avatar/_Vm4sleWmeGl_WhAxTbtMVew"
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.akana.v2020+json

Response Body

Name	Type	Description
userTopApi	userTopApi	Contains information about an API that a user has chosen as a Top API. All fields are returned in the response. See example.

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. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics