Overview

Updated at:
Copy as MD

This topic describes the core concepts of API Gateway to help you develop and call API services.

Protocol conversion

API Gateway is more than a simple reverse proxy service because it also provides protocol conversion. This feature lets you use one protocol to call an interface that uses another. Protocol conversion is language-independent. However, advanced features such as server-side signature verification, data encryption, and decryption are supported only in Java. Currently, other languages can use only basic features.

API Gateway divides protocols into DownProtocol and UpProtocol, as shown in the following figure.

down-up-protocol

  • DownProtocol is the protocol used by a client to send a request to the gateway. API Gateway currently supports the following DownProtocols: HTTP/HTTPS, SOFARPC, and DUBBO.

  • UpProtocol is the protocol used by the gateway to forward a request to the provider. API Gateway currently supports the following UpProtocols: HTTP/HTTPS, SOFARPC, and DUBBO.

API Gateway supports the following protocol conversions:

  • HTTP/HTTPS > HTTP/HTTPS

  • HTTP/HTTPS > SOFARPC

  • SOFARPC > HTTP/HTTPS

  • DUBBO > HTTP/HTTPS

  • HTTP/HTTPS > DUBBO

  • SOFARPC > SOFARPC

Request authentication

To ensure data security during transmission, API Gateway supports signature verification. This includes bidirectional verification for data transmitted between the gateway and subscribers, and between the gateway and providers. Subscribers must sign requests that they send to the gateway. Providers are not required to sign requests.

To use signature verification, you must sign requests before sending them and verify the signature of the responses that you receive. API Gateway provides software development kits (SDKs) for the following languages to simplify this process:

  • API service providers: Java-SDK

  • API service subscribers: js-signature-sdk, Java-SDK

SDKs for other languages are forthcoming. In the meantime, you can implement your own.

Data encryption

The unified gateway lets you encrypt data transmitted between clients and the gateway. It supports three encryption algorithms to ensure data security during transmission: RSA, ECC, and SM (Shang Mi). For more information, see Data encryption.

Note

Currently, data encryption is supported only for HTTP API calls.