POST /api/apis/versions/{APIVersionID}/implementations

Adds an implementation for the specified API version.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for this API.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/apis/versions/{APIVersionID}/implementations

Sample Request

The example below shows a request to add an implementation for the specified API version.

Sample Request URL

https://{hostname}/api/apis/versions/d973f624-60cb-44b8-9ebb-394712c5fe44.acmepaymentscorp/implementations

Sample request headers

POST /api/apis/versions/d973f624-60cb-44b8-9ebb-394712c5fe44.acmepaymentscorp/implementations HTTP/1.1
Host: {hostname}
Accept: application/vnd.soa.v81+json, text/javascript, */*; q=0.01
Content-Type: application/vnd.soa.v81+json
Cookie: {cookie}
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body #1

Creates a new Sandbox implementation (URL required).

For the response, see Sample response body #1.

{
  "ImplementationCode":"Sandbox",
  "Description":"Sandbox implementation.",
  "CreateMechanism":"PROXY",
  "ProxyImplementationRequest":{
    "TargetEndpointURL":[
      "http://www.acmepaymentscorp.com/api/sbox"
    ]
  },
  "APIVersionID":"3c935291-880d-4fb0-855d-9235dc8467d2.acmepaymentscorp"
}

Sample request body #2

Creates a new Sandbox implementation with implementation pattern of Orchestration.

For the response, see Sample response body #2.

{
  "ImplementationCode":"Sandbox",
  "Description":"Sandbox implementation for ACME Payments API (Orchestration).",
  "CreateMechanism":"ORCHESTRATION",
  "APIVersionID":"38fcd5ae-08ae-4161-9fd3-65288dffb92e.acmepaymentscorp"
}

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v81+json
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/vnd.soa.v81+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
APIVersionID	Path	string	Required	The unique ID for a specific API version.
AddAPIImplementationRequest	Body	AddAPIImplementationRequest	Required	Contains information about a request to add an implementation for a specific API version.

Response

If successful, this operation returns HTTP status code 200, with information about the implementation that was added.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v81+json

HTTP/1.1 200 OK
Date: Fri, 20 May 2016 22:33:36 GMT
Content-Type: application/vnd.soa.v81+json

Sample response body #1

Creates a new Sandbox implementation with implementation pattern of Proxy (the default).

For the request, see Sample request body #1 above.

{
  "APIVersionID" : "f10624ed-9a23-4cb9-90d4-595d4a7c64f9.acmepaymentscorp",
  "ImplementationCode" : "Sandbox",
  "Pattern" : "com.akana.pattern.proxy",
  "ServiceKey" : "uddi:e4f16dc7-1eda-11e6-a076-bde7b81dff00",
  "AnonymousAccessAllowed" : true,
  "EndpointAccessAutoApproved" : true,
  "APIOwnedImplementation" : true
}

Sample response body #2

Creates a new Sandbox implementation with implementation pattern of Orchestration.

For the request, see Sample request body #2 above.

{
  "APIVersionID":"38fcd5ae-08ae-4161-9fd3-65288dffb92e.acmepaymentscorp",
  "ImplementationCode":"Sandbox",
  "Pattern":"com.akana.pattern.orchestration",
  "ServiceKey":"uddi:34d5936b-2593-452d-b96f-8d2c29de7066",
  "AnonymousAccessAllowed":true,
  "EndpointAccessAutoApproved":true,
  "APIOwnedImplementation":true
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v81+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.

Response Body

Name	Type	Description
APIImplementationInfo	APIImplementationInfo	Contains information about an API implementation.

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