You can now try our new WebSockets connections for a change.
Requests will still require tokens for security purposes. A Token can be either in a query or use the headers.
The back-end expects all the user input to be in JSON format.
Below are API call examples:
Regular
wss://sock.s3zipper.com/echo // This is hello world echo
wss://sock.s3zipper.com/tokenv2
In Header
Header Name: Authorization
Header Value: Bearer {{ my-token }}
wss://sock.s3zipper.com/v2/header/zipstart
wss://sock.s3zipper.com/v2/header/streamzip
wss://sock.s3zipper.com/v2/header/zipresult
wss://sock.s3zipper.com/v2/header/zipstate
In Query
wss://sock.s3zipper.com/v2/query/zipstart?token=my-token
wss://sock.s3zipper.com/v2/query/streamzip?token=my-token
wss://sock.s3zipper.com/v2/query/zipresult?token=my-token
wss://sock.s3zipper.com/v2/query/zipstate?token=my-token
Example Websocket Body
Getting token
{
"userKey":"my_user_key",
"userSecret":"my_user_secret"
}
Zipstart example
{
"awsKey": "aws_key",
"awsSecret": "aws_secret",
"awsBucket": "my_bucket",
"awsRegion": "us-east-1",
"filePaths": ["my_bucket/files/file1", "my_bucket/files/file2"]
}
Example Response
{ "message": "STARTED", "size": "11 MB", "taskUUID": [ { "idurlv2": "zipper_web_e9951557-836f-4171-818d-19bd1f75767631" } ] }