POST /api/apis/versions/{APIVersionID}/viewers/{ViewerID}

Invites a group to connect to a Private API. When the group is connected, group members can view the API.

Authorization Roles/Permissions: Must have permission to modify the API; an API Admin or Business Admin.

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/apis/versions/{APIVersionID}/viewers/{ViewerID}

Back to top

Sample Request

The example below shows an invitation request.

Request URL

https://{hostname}/api/apis/versions/apiversion19184.acmepaymentscorp/viewers/group19212.acmepaymentscorp

Sample request headers

POST /api/apis/versions/apiversion19184.acmepaymentscorp/viewers/group19212.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

None.

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
ViewerID Path string Required The unique ID for the private viewer being invited.

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 that the request completed successfully.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 15 Feb 2013 15:00:54 GMT
Atmo-Renew-Token: renew

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
Atmo-Renew-Token renew

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. 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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics