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 be logged in. 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
URL
https://{hostname}/api/apis/versions/{APIVersionID}/viewers/{ViewerID}
Sample Request
The example below shows an invitation request.
Sample Request URL
https://{hostname}/api/apis/versions/0ad5f2aa-c390-4108-b5aa-75c860899f3e.acmepaymentscorp/viewers/225e7486-27ca-45b6-a2ed-6306a13257d3.acmepaymentscorp
Sample request headers
POST /api/apis/versions/0ad5f2aa-c390-4108-b5aa-75c860899f3e.acmepaymentscorp/viewers/225e7486-27ca-45b6-a2ed-6306a13257d3.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: text/plain
Content-Type: application/json
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
None.
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 (*/*) |
| 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 |
|---|---|---|---|---|
| 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. |
Response
If successful, this operation returns HTTP status code 200. There is no response content.
Sample Response
The sample response below shows that the request completed successfully.
Sample response headers
HTTP/1.1 200 OK Date: Tue, 01 Dec 2020 19:10:49 GMT Atmo-Renew-Token: renew
Sample response body
None.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | text/plain |
| Atmo-Renew-Token | renew |
Response Body
None.
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.