Overview

Publishing an app as a Peer Service allows other apps to utilize its features as part of their own implementation.

You can set your app to be a peer over on the brainCloud portal.

If you haven't done so yet, create a new app to act as the peer.

Setting up the Peer App

  • Click the [Edit] button to be able to start configuring the peer.
  • Select "Enable As Peer Service" and choose your service visibility.
  1. Private - only apps in your Team will be able to see and connect to the peer. The private setting is the recommended mode to use during development. Or if the peer is internal only, you will always choose the private option.
  2. Public - once your app is live, you can choose to share the peer service publicly. For example, if you were making a weather app, and wanted anyone to be able to access your custom weather scripts in their app.
  • Select how API Usage charges are determined.
  1. Sponsored - When billing occurs, API counts incurred by the peer service are charged to the Peer Service itself. 
  2. Client - API count incurred by the peer service are instead charged to the client apps calling the peer service. This feature is currently not available and will be coming in a later update to brainCloud.

If you plan on only using the peer internally, the choice of whether API Usage calls get charged to your Peer App or Client App may not matter. However, if your Team plans on sharing the Peer Service public, the choice will be an important matter.

  • On the Client Config tab, specify any parameters client apps should provide when using the service.
  • On the Hooks tab, add the scripts that should occur at the event of client actions against the peer. 
  • Finally, on the Directory tab, add the readable information on your peer.


Did this answer your question?