WOLFRAM

Wolfram Language & System Documentation Center

"WolframWebEngine" (Service Connection)

Connect to an instance of Wolfram Web Engine to deploy web apps.

Connecting & Authenticating

ServiceConnect["WolframWebEngine",server] creates a connection to the specified instance of Wolfram Web Engine. An authentication dialog might appear, depending on the configuration.

Requests

ServiceExecute[ServiceObject["WolframWebEngine",…],"request",params] sends a request to the Wolfram Web Engine API using parameters params. The following give possible requests.

Information

Request:

"ListActiveResources" — returns a list of currently deployed active resources

Request:

"GetResource" — imports a resource in the current session; if the resource is active this effectively calls Get

Parameters:
  • "URL"(required)the URL for the resource

    • Deployment

    Request:

    "DeployResource" — deploy a resource

    Parameters:
  • "Payload"(required)a Wolfram Language expression or a static file
    "URL"uuidthe URL for the resource (defaults to a UUID)

    • Deletion

    Request:

    "DeleteResource" — deletes a resource

    Parameters:
  • "URL"(required)the URL for the resource

    • Examples

    Basic Examples  (1)

    Wolfram Language code: so = ServiceConnect["WolframWebEngine", "http://deployer:password@localhost:8010/webengine"]

    List the active resources on the web engine:

    Wolfram Language code: ServiceExecute[so, "ListActiveResources"]

    Deploy a new resource, in this case, an APIFunction:

    Wolfram Language code: ServiceDeploy[so, APIFunction[{"x" -> "Number"}, 3#x + 1&], "test"]

    After deployment, the resource is now available to use:

    Wolfram Language code: ServiceExecute[so, "ListActiveResources"]

    Call the deployed APIFunction with a specific value for x:

    Wolfram Language code: URLExecute[ URLBuild["http://localhost:8010/webengine/active/test", {"x" -> 42}]]

    Delete the resource when you no longer need it:

    Wolfram Language code: ServiceExecute[so, "DeleteResource", {"URL" -> "active/test"}]