Versions Compared

Old Version 2

changes.mady.by.user Jenni Wallin

Saved on

compared with

New Version 3

changes.mady.by.user Jenni Wallin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleNote!

In all parameter descriptions below, "HTTP" may refer to both HTTP and HTTPS, and both HTTP/1 and HTTP/2.

httpGet

This function uses the GET method to retrieve content from an HTTP server.

...

ParameterDescription

host

The name or IP address of the HTTP server. 

path

The path.

Info
titleExample - path


Code Block
/api/v2/doc



protocolThe protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1.
port

The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.

secureIndicates whether the data should be sent in secure mode or not.

requestTimeout

The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.

connectionTimeout

The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.

username

A username for an account on the HTTP server.

password

Password associated with the username.

headers

Custom HTTP request headers.

Returns

Content from the HTTP server. It will be null if any part of the communication fails.

httpPost

This function uses the POST method to send content to an HTTP/2 server and receives the response.

...

ParameterDescription

host

The name or IP address of the HTTP server. 

path

The path

Info
titleExample - path


Code Block
/api/v2/doc



bytearraycontent

The body of the request in bytearray format.

contentType

The MIME type of the content.

Info
titleExample - contentType


Code Block
application/json



protocol

The protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1.

port

The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.

secureIndicates whether the data should be sent in secure mode or not.

requestTimeout

The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.

connectionTimeout

The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.

username

A username for an account on the HTTP server.

password

Password associated with the username.

headers Custom HTTP request headers.

Returns

Content from the HTTP server. It will be null if any part of the communication fails.

httpReq

This function makes an HTTP request and uses the specified method, e g GET, POST, PUT etc.

...

ParameterDescription

method

The HTTP method.

host

The name or IP address of the HTTP server. 

path

The path

Info
titleExample - path


Code Block
/api/v2/doc



content

The body of the request in bytearray format.

contentType

The MIME type of the content.

Info
titleExample - contentType


Code Block
application/json



protocolThe protocol used: HTTP/1 or HTTP/2. The default value is HTTP/1.

port

The port number to contact the HTTP server on. Port 80 is used for HTTP connection and 443 is used for HTTPS connection by default.

secureIndicates whether the data should be sent in secure mode or not.

requestTimeout

The number of milliseconds to wait for a response. If the value is not specifically specified, the default timeout is used. The default value is 15000 milliseconds.
connectionTimeout The number of milliseconds to wait for a connection to be established. If the value is not specifically specified, the default timeout is used. The default value is 3000 milliseconds.

username

A username for an account on the HTTP server.

password

Password associated with the username.

headers Custom HTTP request headers.

Returns

A response from the HTTP server. It will be null if any part of the communication fails.

httpMultipartPost

This function uses the POST method to send multipart binary contents to an HTTP server and receives the response.

...

Note
titleNote!

For optional parameters, you need to state null in case you specify subsequent optional parameters. If there are no subsequent parameters, you do not have to state anything.

Info
titleExample


Code Block
httpMultipartPostURL( "mypath", mybody, "myhost", 0, null, "myusername");




TLS/SSL Encryption

When selecting secure, a keystore is required. In this case, the use of a truststore is supported.

Anchor
JavaKeystore
JavaKeystore
Configure Java Keystore for Secure URL Functions

Keystore is used to store HTTP Client’s credential. This certificate is sent to a server for authentication if required.

...

See the JVM product documentation for more information about how to use the keytool.

Configure Java Truststore for Secure URL Functions 

A truststore is a keystore that is used when deciding what to trust - truststore stores certificates from third parties. If you receive data from an entity that you already trust, and if you can verify that the entity is what it claims to be, you can assume that the data does in fact come from that entity.

...