Class ExternalServiceProxySystem

Inheritance Relationships

Base Type

Class Documentation

class ExternalServiceProxySystem : public csp::systems::SystemBase

Public facing system that allows client applications to interact with backend services acting as a proxy for some other set of services.

In situations where a CSP client application needs secure access to some other set of third-party services (like AI, VOIP, ECommerce etc), this system can be particularly helpful, as it enables services that CSP interfaces with to own the responsibility of distributing secure tokens to those platforms.

Public Functions

void InvokeOperation(const ExternalServicesOperationParams &Params, StringResultCallback Callback)

Generic function which will make a post request to the services proxy endpoint to trigger some specified operation of specified service.

The nature of the operation and what is returned is entirely dependent on the service and operation name provided.

Parameters

  • Params – const TokenInfoParams& : Params to specify service, operation, set help and parameters.

  • Callback – StringResultCallback : Callback to call when a response is received.

void GetAgoraUserToken(const AgoraUserTokenParams &Params, StringResultCallback Callback)

Specialised utility function which executes a post call to the external services proxy, specifically to retrieve Agora user token credentials.

A good example for how client applications may wish to use PostServiceProxy.

Parameters