Skip to main content
All CollectionsPortal-X Pages
Design | Cloud Code | API Explorer
Design | Cloud Code | API Explorer

The API explorer provides a quick way to experiment with the Client APIs, and even your own scripts.

Jason Liang avatar
Written by Jason Liang
Updated over a week ago

The API Explorer allows you to explore and run all the key methods of the brainCloud API. It simulates a client application talking to the brainCloud servers. It is a great way to test the APIs and confirm their behaviors and JSON return formats.

The explorer screen consists of the following components:

  • Summary Info - This section displays information about the currently active session, including the active Session ID and Profile ID

  • Service - allows you to select one of the many brainCloud services. Once you select a service, the Operation list will update to reflect methods available for that service

  • Operation - the operation (API method) to invoke

  • Description - a description of the method, complete with a link to the appropriate API Reference page

  • Parameters - the parameters to send into the method. Will be populated with a default template, that you can manually edit to simulate your test

  • [EXECUTE] - clicking the EXECUTE button executes the request

  • Log - the log updates to show each request, followed by its response - with a tally of how many milliseconds it took to run the operation

Notes

  • Authentication - The portal automatically fills in your development email as both the ID and password for Authentication - useful for creating test users

  • Session timeouts - the session created using the API Explorer remains active even as you move back and forth to other parts of the Portal. Useful if you want to execute an operation, and then examine its effect via Global or User Monitoring. Sessions timeout after 15 minutes or so.

  • Login as User - If you want to log in as a specific user for testing / debugging purposes, you can locate that user via User Browser, and then click the [Login As User] button near the top-right of the page.

To get started, the first call you are going to run on your App is the Initialize call, to pair your app client with your app on brainCloud. Since you are already in the context of your app from the portal, you need to perform the next step you user would, Authentication.

  • The Bypass App Enabled check will allow you to continue to run API calls should you have disabled your app on the Design | Core App Info | Advanced Settings page.

  • For each selected Operation, you would see a description of what the service does, along with an API Reference link.

After you are authenticated, test the API call with the following steps

  • Go to the Entity service and CreateEntity operation, which will allow you to create data objects connected to the current user profile.

  • Change the entityType parameter value to myEntityType, then click EXECUTE button. Example:

  • You can go back to check the requests and responses you made through the logs section or copy these logs for debugging purposes.

Also, note that if you see some methods with a special badge that means they are only callable from Cloud Code.

Did this answer your question?