HTTP Client

This service allows you to make HTTP requests to external third party websites. Currently only JSON formatted responses are supported.

The "serviceCode" parameter in the following operations refers to the items configured in “Cloud Code/Web Services” tab of the portal. You must configure (declare) the external service via the Cloud Code - Web Services page of the brainCloud portal first.

API Summary

Get

• GetResponseJson() - Retrieves a Json document.
• GetResponseText() - Retrieves a Text document.

Post

• PostJsonResponseJson() - Posts a JSON document, expects a Json response.
• PostJsonResponseText() - Posts a JSON document, expects a text response.
• PostJsonOffboard() - Posts a JSON document in the background, without waiting for a response.
• PostFormResponseJson() - Posts a Form encoded document, expects a Json response.
• PostMultipartResponseJson() - Posts a Form encoded document, expects a Json response.
• PostFormResponseText() - Posts a Form encoded document, expects a Text response.
• PostTextResponseText() - Posts a text document, expects a Text response.
• PostTextResponseJson() - Posts a text document, expects a Json response.

Put

• PutJsonResponseJson() - Puts a JSON document, expects a Json response.
• PutTextResponseText() - Puts a text document, expects a Text response.

Patch

• PatchJsonResponseJson() - Patches a JSON document, expects a Json response.
• PatchTextResponseText() - Patches a text document, expects a Text response.

Delete

• DeleteJsonResponseJson() - Deletes a document, passes a Json body, expects a Json response.
• Delete() - Deletes a document., expects a Text response.

Other

• ParseRequest() - Makes a request to Parse Rest API.
• HeadRequest() - Executes a HEAD request.

tip

The above listed HTTPClient APIs are available to S2S. For the usages of the these APIs (if they are not described at this section), refer to brainCloud Cloud Code httpClient APIs section.

📄️ GetResponseJson

This operation retrieves a JSON document from an external web site.

📄️ GetResponseText

This operation retrieves a Text document from an external web site.

📄️ PostFormResponseJson

This operation posts a form encoded document and expects a JSON formatted document in response.

📄️ PostFormResponseText

This operation posts a form encoded document and expects a Text document in response.

📄️ PostJsonOffboard

Posts a JSON document to an offboard service. Send and forget.

📄️ PostJsonResponseJson

This operation posts a JSON document and expects a JSON formatted document in response.

📄️ PostJsonResponseText

Posts a JSON document, expects a text response.

📄️ PostTextResponseText

This operation posts a Text document and expects a Text document in response.