Calling Web Services

createSession(): WebClient

const session = web.createSession();

const res = session.request("https://service.domain.com/api/login")
              .fetch();

// this request has the same cookies as the above
const res2 = session.request("https://service.domain.com/api/endpoint")
              .fetch();

// this request didn't reuse the cookies of the first 2
const res3 = web.request("https://service.domain.com/api/other")
              .fetch();

decodeBase64(input: string): string

encodeBase64(input: string): string

newClient(): WebClient

proxy(hostname: string, port: number): WebClient

request(url: string): WebRequest

const res = web.request("https://service.domain.com/api/123")
             .fetch();

console.log(res.status); // prints the HTTP status code, e.g. '200'

// res.json is a JSON object of the response (if the API returns JSON)
// e.g. if the request returns '{ value: "hello" }'
const greeting = res.json.value; // greeting has the value 'hello'

// If the response is not JSON, we can inspect the full value
const body = res.body; // body has the value '{ value "hello" }'

res.headers; // A JSON object of headers in key/value pairs
// e.g
res.headers["Content-Type"]; // could be 'application/json; charset=utf-8'

readonly DELETE: WebRequest.Methods

const req = web.request("https://service.domain.com/api/123")
             .method(web.DELETE)
             .json({
                 property: "value"
             });

req.fetch();

readonly GET: WebRequest.Methods

const req = web.request("https://service.domain.com/api/123");
             // .method(web.GET) This is the default and not required

req.fetch();

readonly PATCH: WebRequest.Methods

const req = web.request("https://service.domain.com/api/123")
             .method(web.PATCH)
             .json({
                 property: "value"
             });

req.fetch();

readonly POST: WebRequest.Methods

const req = web.request("https://service.domain.com/api/123")
             .method(web.POST)
             .json({
                 property: "value"
             });

req.fetch();

readonly PUT: WebRequest.Methods

const req = web.request("https://service.domain.com/api/123")
             .method(web.PUT)
             .json({
                 property: "value"
             });

req.fetch();

addHeader(name: string, value: string): WebRequest

body(data: string): WebRequest

fetch(): WebResponse

formBody(formData: object): WebRequest

const res = web.request("https://example.com/formapi")
             .formBody({
                 "grant_type", "urn:...",
                 "other_param", "value"
             })
             .method(web.POST)
             .fetch();

formParts(partData: object): WebRequest

const res = web.request("https://example.com/formapi")
             .formParts({
                 "name", "partValue",
                 "otherName", "value"
             })
             .method(web.POST)
             .fetch();

header(name: string, value: string): WebRequest

headers(headers: object): WebRequest

json(data: object): WebRequest

method(method: WebRequest.Methods): WebRequest

timeout(seconds: number): WebRequest

const response = web.request("https://service.domain.com/api/slow/task")
                    .timeout(2280) // 2280 seconds or 38 minutes
                    .fetch();

console.log(response.body);

trustAllCertificates(): WebRequest

const response = web.request("https://incomplete-chain.badssl.com/")
                    .trustAllCertificates()
                    .fetch();

console.log(response.body);

useBasicAuth(username: string, password: string): WebRequest

const func = web.request("https://service.domain.com/api/123")
             .useBasicAuth("username", "password");

func.fetch();

useCredentials(credentials: any): WebRequest

const func = web.request("https://service.domain.com/api/123")
             .useCredentials(action.input.someCredentials);

func.fetch();

readonly body: string

readonly headers: object

readonly json: any

readonly request: WebRequest

readonly status: number

readonly xml: any

<catalog>
    <book id="bk101">
        <author>A, Name</author>
        <title>A book</title>
    </book>
    <book id="bk102">
        Simple Book
    </book>
</catalog>

{
    "__name": "catalog",
    "__attributes": {},
    "__children": [
        {
            "__name": "book",
            "author": "A, Name",
            "title": "A book",
            "__attributes": {
                "id": "bk101"
            },
            "__children": [
                {
                    "__name": "author",
                    "__value": "A, Name"
                },
                {
                    "__name": "title",
                    "__value": "A book"
                }
            ]
        },
        {
            "__name": "book",
            "#text": "Simple Book",
            "__value": "Simple Book",
            "__attributes": {
                "id": "bk102"
            },
            "__children": [
                {
                    "__name": "#text",
                    "__value": "Simple Book"
                }
            ]
        }
    ]
}