HOW TO USE S3ZIPPER API
S3zipper has a lot of examples to follow in Postman .
NB: There are four steps for using the Main Web API & three steps for using the EC2 version:
GETTING USERKEY & USERSECRET (WEB API ONLY)
First create an account if you don’t have one here:
https://s3zipper.com/registration/register
else, login here:
https://s3zipper.com/registration/login
Get the user key and user secret here:
https://s3zipper.com/auth/develop
USING THE MAIN WEB API (V1 & V2)
API = The API call
DOCS = The documentation for this API
1. Generate the token
API : https://api.s3zipper.com/gentoken
DOCS : https://docs.s3zipper.com/#6ed32e6a-62c8-e2db-c01a-f768c75d3904
API : https://api.s3zipper.com/tokenv2
DOCS : https://docs.s3zipper.com/#76e66131-c5e7-4f59-8495-f5f216c01bd3
2 a) Start a zipping process that generates a downloadable web URL using the token. It returns a Job ID.
API : https://api.s3zipper.com/v1/streamzip
DOCS :https://docs.s3zipper.com/#c1a1f851-cdb6-5d63-eeea-87bbb34799b1
API : https://api.s3zipper.com/v2/streamzip
DOCS :https://docs.s3zipper.com/#b764bd66-8810-46ad-9e49-526b34d7af8d
This API call starts immediately and returns Job ID ASAP.
API : https://api.s3zipper.com/v2/streamzipidDOCS :https://docs.s3zipper.com/#0e823ce3-f1f7-4c0a-b2ae-1deee3601baa
2 b) Start a zipping process that zips files directly to AWS S3 bucket using token. It returns Job ID.
API : https://api.s3zipper.com/v1/zipstart
DOCS :https://docs.s3zipper.com/#7487bc23-8253-a58f-2a45-3c7fdb5ea823
API : https://api.s3zipper.com/v2/zipstart
DOCS :https://docs.s3zipper.com/#12577969-697b-4cf6-8dfd-c6346f287cc6
This API call starts immediately and returns Job ID ASAP.
API : https://api.s3zipper.com/v2/zipstartidDOCS :https://docs.s3zipper.com/#aaef002d-f261-4717-bd5c-3b4ff5dbe06b
3. Check the status of the Job ID. Not ideal for getting results.
API : https://api.s3zipper.com/v1/zipstate
DOCS :https://docs.s3zipper.com/#5440bd09-0c64-794c-0c92-d58af30c313f
API : https://api.s3zipper.com/v2/zipstate
DOCS :https://docs.s3zipper.com/#a329ba75-5039-47f8-a31b-89f284cba35f
4. Get the result using Job ID.
API : https://api.s3zipper.com/v1/zipresult
DOCS : https://docs.s3zipper.com/#fc7934f5-405c-3c2c-05f5-3f2803638a32
API : https://api.s3zipper.com/v2/zipresult
DOCS :https://docs.s3zipper.com/#6087f2fe-e8af-4a31-b46c-9ce57d4ff30c
USING THE EC2 VERSIONS (V1 & V2)
The EC2 version has two simple steps.
1 a) Start a zipping process that generates a downloadable web URL. It returns a Job ID.
API : http://<public-ip|domain>/v1/streamzip
DOCS : https://docs.s3zipper.com/#09d11725-479d-49af-89a4-236a9245c23d
API : http://<public-ip|domain>/v2/streamzip
DOCS : https://docs.s3zipper.com/#fd653b3a-7e63-485e-8210-842eac9eb399
1 b) Start a zipping process that zips files directly to AWS S3 bucket. It returns Job ID.
API : http://<Public-IP|Domain>/v1/s3zip
DOCS :https://docs.s3zipper.com/#f34b1b49-9518-4690-b29f-6cee9b6326a7
API : http://<Public-IP|Domain>/v2/s3zip
DOCS : https://docs.s3zipper.com/#90c2c0cc-afbf-4fbe-9cb3-040d8fe9a480
2. Check the status of Job ID. It returns the status with result or errors.
API : http://<Public-IP|Domain>/v1/status
DOCS : https://docs.s3zipper.com/#500ed591-f317-4ad2-b870-cf8923bf11d4
API : http://<Public-IP|Domain>/v2/status
DOCS : https://docs.s3zipper.com/#7e282bbb-834e-48a5-9044-cde15e2cd042