HomeWiki
HomeWiki
  1. Web Requests
  • Back to home
  • 2. Connectivity
  • Introduction
  • Custom Script
  • Playground
  • Database Explorer
  • Log Stream
  • Direct Communication
  • Softone
    • Getting Started
  • Datapump
    • Getting Started
    • Crons
    • Legacy Windows Support
    • SDK
      • DB
        • _executeQuery
        • _executeStoreProcedure
        • _executeInsertQuery
        • _executeInsertQueriesInTransaction
      • Import
        • _productsImport
        • _categoriesImport
        • _brandsImport
        • _attributesImport
        • _attributeSetsImport
        • _unitsImport
        • _quantityImport
        • _customersImport
        • _contactsImport
        • _callsImport
        • _eventsImport
        • _tasksImport
        • _ordersImport
        • _usersImport
        • _customerSourceTagsImport
        • _productSourceTagsImport
      • Log
        • _logDebug
        • _logInfo
        • _logWarn
        • _logError
      • Web Requests
        • _httpGetJson
        • _httpPostJson
        • _httpPutJson
        • _httpDeleteJson
        • _httpPatchJson
      • Variables
        • _saveVariable
        • _getVariable
        • _deleteVariable
      • Blob
        • _blobConnect
        • _blobExists
        • _blobGet
        • _blobFind
      • Utils
        • _encodeBase64
        • _sleep
        • _getLastSyncDate
        • _updateLastSyncDate
        • _resetLastSyncDate
  1. Web Requests

_httpPostJson

Documentation: _httpPostJson Function#

The _httpPostJson function is designed to perform an HTTP POST request to a specified URL, sending a payload in JSON format. The function allows for the inclusion of custom headers and handles different encoding formats. It returns the HTTP status code and the content of the response.

Function Signature:#

Parameters:#

url (Required):
Description: The URL to which the POST request is sent. This should be a valid URL pointing to the resource or API endpoint that will handle the JSON payload.
Type: String
Example:
headers (Required):
Description: An object containing key-value pairs representing the headers to be included in the POST request. These headers can be used for authorization, content type, or any other required metadata.
Type: Object
Example:
payload (Required):
Description: The data to be sent in the body of the POST request, typically an object that will be serialized to JSON format.
Type: Object
Example:
encoding (Optional):
Description: The encoding format used to encode the request body and decode the response content. If not provided, the default encoding is utf-8. This can be useful when dealing with different character encodings.
Type: String
Default: 'utf-8'
Example:

Return Value:#

Returns:
A JSON object containing the HTTP status code and the content of the response. The structure includes:
StatusCode: The HTTP status code returned by the server.
Content: The body of the response, typically a JSON object or string, depending on the response format.
Type: Object
Example:

Function Workflow:#

1.
Validate Input:
The function checks if the url is provided and is a valid string. If the url is missing or invalid, an error may be raised or the operation may be aborted.
2.
Prepare HTTP Request:
The function creates an HTTP client and prepares the POST request with the specified url.
It sets the request headers using the headers object. These headers often include Authorization tokens and Content-Type.
The payload is converted to a JSON string using the specified encoding (default is utf-8).
3.
Send HTTP Request:
The function sends the POST request with the JSON-encoded payload to the specified url.
4.
Handle Response:
The function checks the response status code. If the response is successful (e.g., status code 201), it reads the response content.
The content is decoded using the specified encoding and parsed as JSON if applicable.
5.
Return JSON Object:
The function constructs a JSON object containing the StatusCode and the Content of the response. This JSON object is returned to the caller.
6.
Exception Handling:
If any exception occurs during the request (e.g., network errors, invalid JSON), the function may log the error and return an appropriate response object with an error status code.

Example Usage:#

Important Considerations:#

Ensure URL Validity:
The url parameter must be a valid and reachable URL. If the URL is incorrect or unreachable, the function may return an error or an unsuccessful status code.
Include Necessary Headers:
The headers object should include all necessary headers, such as authorization tokens, content types, and any other required information for the request.
Format Payload Correctly:
The payload parameter must be formatted correctly as an object. It will be serialized to JSON before being sent in the request body.
Handle Different Encodings:
If the response content or the payload uses a different encoding format, specify the correct encoding in the encoding parameter to ensure proper handling.
By using _httpPostJson, you can efficiently send data to APIs and other resources while managing custom headers and different encoding formats. The function simplifies the process of making POST requests and handling responses in your application.
Modified at 2024-08-23 12:13:26
Previous
_httpGetJson
Next
_httpPutJson
Built with