You can generate an API by signing in to Flex.io
This function allows you to supply your API key to the SDK library. You can generate an API key from the Flex.io dashboard after you sign in.
Creates a new connection object. The connection object specified in the parameter
conn can either be a plain object with the desired key/value pairs set or alternativily a Flexio.connection object.
Loads a connection object. Once the load operation has completed, the callback function will be invoked.
Retrieve a list of connections available to the user. Upon completion of the call, an array of connection info objects will be returned via the callback function.
Loads a pipe object. Once the load operation has completed, the callback function will be invoked.
Retrieve a list of pipes available to the user. Upon completion of the call, an array of pipes will be returned via the callback function.
Additional parameters, such as query string parameters (so-called ‘GET parameters’), or form parameters and files may be specified in the optional
When the pipe has finished executing, the callback function will be invoked if one has been specified. The spec for the callback function is
The response object has several properties used to retrieve the response payload.
response.text is used to get a text payload.
response.data is used to get a JSON object payload. The raw binary payload, which is used for images and other binary data, can be directly accessed via
response.buffer, and in an ArrayBuffer object. In a web browser client setting, a Blob object can be accessed via
These functions are convenience functions that invoke the functionality of
Flexio.pipes.run(), which is documented above.
pipe.render() renders a web page to an image or PDF file. By default, a PNG image of the webpage is generated. An optional
params argument can be specified with various options that modify the behavior of the rendering process. Here are a list of the options that can be specified on the
|format||The file format to generate (possible values are ‘jpeg’, ‘pdf’, or ‘png’). Defaults to ‘png’|
|full||A boolean true/false indicating whether the full webpage from top to bottom should be rendered. Defaults to false.|
|height||The height of the resulting image. If
|scrollbars||A boolean true/false indicating whether or not scrollbars are included in the rendered image. Defaults to false.|
|paper||When rendering a PDF, this option specifies the paper size to use. (Possible values ‘A4, ‘Letter’, etc.) Defaults to ‘Letter’|
|url||The URL to navigate to|
|width||The width of the resulting image. If
pipe.python() adds a Python execute step to the pipe. The code for the script is passed as a string parameter to the function.