💻
Open Source Oasis
  • TLS-Client
    • Supported and tested Client Profiles
    • Installation & Quick Usage
    • Client Options
    • Cookiejar
    • Defaults
    • Request Headers
    • Pseudo Header Order
    • Proxies
    • Certificate Pinning
    • Response Body Encoding / Decoding
    • Custom Client Profile
    • Examples
  • Shared Library
    • Node Version
    • Downloads
    • Build from source
    • Exposed Methods
    • JavaScript
      • Examples
    • Python
      • Examples
    • TypeScript
      • Examples
    • C#
      • Examples
    • Defaults
    • Payload
    • Response
    • Memory Issues
  • Standalone API Application
    • Download
    • Build from source
    • Configuration & Start
    • Endpoints
    • Defaults
    • Attention
    • Payload
    • Response
  • How to get support
    • Frequently Asked Questions / Errors
    • Community Support
  • Further Information
  • Antibots & Captchas
  • Community Projects
Powered by GitBook
On this page
  1. Shared Library

Exposed Methods

PreviousBuild from sourceNextJavaScript

Last updated 2 years ago

The shared library exposes the following endpoints / methods you can call. The payload is always a JSON string expect for the freeMemory method. You will find the methods also in use in the examples.

request(payload: string) => string

This is the basic method you will use to do requests. For full detailed documentation about the payload please take a look at . As you see here on other methods you have to turn the JSON Object into a JSON string before supplying it as the payload parameter.

getCookiesFromSession(payload: string) => string

Get all cookies which are in the provided session for a given URL. The payload should look like this:

"{\"sessionId\": \"someExistingSessionId\", \"url\": \"urlToGetCookiesFor\"}"

addCookiesToSession(payload: string) => string

Add manual cookies to an existing session. The payload should look like this:

"{\"sessionId\": \"someExistingSessionId\", \"url\": \"urlToAddCookiesFor\", \"cookies\": []}"

freeMemory(responseId: string) => void

Supply the "id" of a previous response as string in order to free the allocated memory of the previous response.

destroyAll() => string

Destroy all existing sessions in order to release allocated memory.

destroySession(payload: string) => string

Destroy a specific session in order to release allocated memory. The payload should look like this:

"{\"sessionId\": \"someExistingSessionId\"}"

Payload