API Documentation

Use the ZipKit API to easily create zipped archives of your S3 objects.

Getting started

To get started with making authenticated HTTP requests to the Zips endpoint, you'll need to follow these steps:

  1. Create an Account: Begin by signing up for an account, this will give you access to the necessary tools and resources to utilize the API.
  2. Create a Project: Once logged in, create a project within your account dashboard. This project will serve as the container for your zipping tasks and help organize your API usage.
  3. Generate an Access Token: Within your project settings, generate an access token. This token will be used to authenticate your HTTP requests to the Zips endpoint, ensuring secure communication with the ZipKit API.
  4. Include Access Token in Requests: With your access token generated, include it in the headers of your HTTP requests to the Zips endpoint. This authentication step allows ZipKit to verify your identity and authorize your access to the zipping functionality.

By completing these steps, you'll be ready to start making authenticated HTTP requests to the Zips endpoint, enabling you to efficiently create zipped archives of your S3 objects through the ZipKit API.

Guides

Authentication

Learn how to authenticate your API requests.

Read more

Errors

Read about the different types of errors returned by the API.

Read more

Webhooks

Learn how to programmatically configure webhooks for your app.

Read more

Resources

Zips

Learn about the zip model and how to create new zips.