GET /api/apis/versions/implementations

Returns information about API implementations, based on a provided APIID, APIVersionID, Service Key, or implementation code.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/apis/versions/implementations[?][APIID={APIID}]&[APIVersionID={APIVersionID}]
&[ServiceKey={ServiceKey}]&[ProxiedServiceKey={ProxiedServiceKey}]&[ImplementationCode={ImplementationCode}]

Sample Request #1

The example below shows a request for API implementation information. To view the response, see Sample Response #1.

Sample Request URL

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

Sample request headers

Accept: application/vnd.soa.v81+json

Sample request body

Not applicable.

Sample Request #2

The example below shows a request for API implementation information for the specified API version. To view the response, see Sample Response #2.

Sample Request URL

https://{hostname}/api/apis/versions/implementations?APIVersionID=4ef0b707-a7f1-45eb-8343-cb6fb443ef02.acmepaymentscorp

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
APIID	Query	string	Optional	The unique ID for a specific API.
APIVersionID	Query	string	Optional	The unique ID for a specific API version.
ServiceKey	Query	string	Optional	Unique service key for a specific service implementation; for example, uddi:f1ebef06-f0a8-11e3-b49c-efec5910417e. When adding an implementation from an existing service, it is the unique service key for the service, as set up in Policy Manager.
ProxiedServiceKey	Query	string	Optional	The service key for a proxied API, if applicable.
ImplementationCode	Query	string	Optional	Code name for the API implementation.

Response

If successful, this operation returns HTTP status code 200, with the requested information about API implementations.

Sample Response #1

The sample response below shows successful completion of this operation. Information on all implementations is returned. To view the request, see Sample Request #1.

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

Content-Type: application/vnd.soa.v81+json
Date: Thu, 12 Mar 2020 15:46:15 GMT

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

{
  "APIImplementationInfo": [
    {
      "APIVersionID": "4ef0b707-a7f1-45eb-8343-cb6fb443ef01.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:f77746c7-2e3e-11e9-a4a0-8de6ca732541",
      "AnonymousAccessAllowed": false,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    },
    {
      "APIVersionID": "b5c1abf8-2c42-47b8-992d-285e2bffd8e1.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:f6e68154-39eb-11e9-a1ea-9aea37a739b1",
      "AnonymousAccessAllowed": true,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    },
    {
      "APIVersionID": "e73b5ce8-f516-4641-9596-4fe51c977031.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:68845a9b-404b-11e9-a1ea-9aea37a739b1",
      "AnonymousAccessAllowed": true,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    },
    {
      "APIVersionID": "440065bd-7655-42dc-9a14-3387e70f52f1.acmepaymentscorp",
      "ImplementationCode": "Sandbox",
      "Pattern": "com.akana.pattern.orchestration",
      "ServiceKey": "uddi:ee3ae12d-c5d6-11e9-bddb-d3399bf759f1",
      "AnonymousAccessAllowed": false,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    },
    {
      "APIVersionID": "1ff80b00-de4a-4588-a951-2312bf72a021.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:cc609cb0-d33d-11e9-bddb-d3399bf759f1",
      "AnonymousAccessAllowed": true,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    },
    {
      "APIVersionID": "38fcd5ae-08ae-4161-9fd3-65288dffb921.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:ce10ea5a-4177-11ea-be1c-b71095ab9d81",
      "AnonymousAccessAllowed": true,
      "EndpointAccessAutoApproved": true,
      "APIOwnedImplementation": true
    }
  ]
}

Sample Response #2

The sample response below shows successful completion of this operation. In this scenario, the optional APIVersionID parameter was used in the request. API implementation information for the specified API version is returned. To view the request, see Sample Request #2.

Sample response headers: application/json

Content-Type: application/json
date: Thu, 12 Mar 2020 15:49:17 GMT

Sample response body: application/json

{
  "APIImplementationInfo": [
    {
      "APIVersionID": "4ef0b707-a7f1-45eb-8343-cb6fb443ef02.acmepaymentscorp",
      "ImplementationCode": "Live",
      "Pattern": "com.akana.pattern.proxy",
      "ServiceKey": "uddi:f77746c7-2e3e-11e9-a4a0-8de6ca732541",
      "AnonymousAccessAllowed": false,
      "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

Response Body

Name	Type	Description
APIImplementationInfos	APIImplementationInfos	Contains information about one or more implementations for an API version.

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.