About APEX APIs

This section covers the full lifecycle of managing APIs on APEX — from creation and design through publishing, editing, and ongoing maintenance.

Creating APIs

• Create a REST API from an API Spec — Publish a REST API using an OpenAPI Specification or the APEX API Designer
• Create a SOAP API from WSDL — Host a SOAP API by uploading a WSDL file
• Designing reusable API templates — Use the visual API Spec Designer to create standards-compliant API templates

Authentication

• Supported inbound and outbound authentication — Overview of the authentication methods available for securing consumer-to-gateway and gateway-to-backend traffic
• Handling AWS SigV4 authorization — Generate AWS Signature Version 4 for authorization for AWS gateway-to-backend requests

Managing the API lifecycle

• Publishing and managing API lifecycle — Transition APIs between draft, published, deprecated, and retired states
• Edit draft APIs — Freely edit unpublished APIs before they go live
• Edit live APIs — Make changes to published APIs without disrupting active consumers
• Bridge an API — Extend an API’s reach across environments (e.g. intranet to internet)

Access and subscriptions

• Manage organization access — Grant other organizations access to subscribe to your published APIs

Certificates and connectivity

• Manage trusted certificates for a single API — Upload or remove trusted certificates for draft APIs
• Mass API trusted certificate rotation — Add or remove certificates across multiple APIs at once
• Validate network connectivity — Test that the APEX gateway can reach your upstream server

Outbound overrides

• Manage outbound overrides — Forward additional headers, cookies, or query parameters to your upstream server
• Forward consumer application ID as an outbound variable — Dynamically pass each consumer’s application ID upstream
• Handling AWS SigV4 authorization as outbound variables — Generate AWS Signature Version 4 for authorization for AWS gateway-to-backend requests

Upgrading APIs

• About upgrading APIs — Safely roll out significant changes by running a cloned API in parallel with the original
  • Clone an API — Create an editable copy of a published API without affecting the original
  • Copy API access to other APIs — Transfer an existing API’s subscriber list to the cloned API
  • (Optional) Retiring the older API — If you intend to fully replace the original API with the cloned version, you must retire the original so that traffic routes correctly to the new API