Quickstart guide

Everabyte Cloud Storage API Quickstart Guide

Introduction

Welcome to the Everabyte Cloud Storage API! This guide will help you get started with our API services across all our storage plans: EverBlaze, EverStream, EverLock, and Cloud NAS.

Prerequisites

Before you begin, ensure you have:

Everabyte Account: An account with one of our storage plans:

EverBlaze: High-performance object storage

EverStream: Optimized for streaming and media

EverLock: Secure and encrypted storage

Cloud NAS: Network-attached storage solution

Registered Email and Password: Your login credentials.

HTTP Client: Any HTTP client like cURL, Postman, or your preferred programming language.

Authentication

To start using the Everabyte API, you first need to authenticate and obtain a token.

Authentication Request

Successful Authentication Response

{
    "status": 200,
    "message": "Successful connection",
    "data": {
        "token": "your_token_generated"
    }
}

Important: Keep your token secure and never expose it in public repositories or client-side code.

Using Your Token

After obtaining your token, include it in the Authorization header for all subsequent API requests:

Available Storage Plans

All API endpoints are accessible through https://api.everabyte.io/api, regardless of your storage plan. However, features and limitations may vary based on your subscription.

Step 1: Obtain Your API Key

To authenticate with the Everabyte API, you need an API Key. Here's how to get yours:

Navigate to API Settings under your account settings.

Generate a new API Key and copy it.

Tip: Keep your API key secure and never expose it in your public code or repositories.

Step 2: Set Up Your Environment

Choose how you want to interact with the API. For this guide, we’ll use Curl, a command-line tool that makes it easy to send HTTP requests.

Alternatively, you can use Postman, or if you prefer, you can interact directly from your code.

Step 3: Make Your First API Request

Now that you have your API key, you're ready to make your first API request. Let’s start by fetching some basic information about your storage account.

Example Request (using Curl):

Replace YOUR_API_KEY with the actual API key you obtained in Step 1.

Expected Response:

{
    "status": 200,
    "message": "User found successfully",
    "data": {
        "id": "user_id",
        "email": "your_email@domain.com",
        "username": "my_username",
        "avatar": null,
        "theme": null,
        "lang": "en",
        "information": {
            "id": "information_id",
            "firstName": null,
            "lastName": null,
            "telephone": null,
            "birthday": null,
            "gender": null,
            "website": null,
            "facebook": null,
            "twitter": null,
            "linkedin": null,
            "instagram": null
        }
    }
}

This will return details about your account, including how much storage you have used and how many files are stored.

Step 4: Upload a File

Now, let’s upload a file to Everabyte Cloud Storage. This can be done via a simple POST request.

Example Request (using Curl):

Replace /path/to/your/file.txt with the actual file you want to upload.

Expected Response:

{
    "status": 200,
    "message": "File uploaded successfully.",
    "data": ""
}

The file is successfully uploaded, and the response includes information about the uploaded file, such as its ID, name, size, and the URL where it’s stored.

Step 5: List Files in Your Storage

To list all the files you have uploaded to Everabyte Cloud Storage, send a GET request to the files endpoint.

Example Request (using Curl):

Expected Response:

{
    "status": 200,
    "message": "",
    "data": {
        "total": 0,
        "data": []
    }
}

This will return a list of all files in your storage account.

Step 6: Download a File

If you want to download a file that’s stored on Everabyte Cloud Storage, you can send a GET request with the file ID.

Example Request (using Curl):

This will initiate the download of the file with ID abc123 (replace with the actual file ID).

Step 7: Handling Errors

Throughout the process, if something goes wrong, the Everabyte API will return an error code and message. Common error codes include:

400 Bad Request: The request is malformed or missing required parameters.

401 Unauthorized: Invalid or missing API key.

404 Not Found: The resource you’re trying to access doesn’t exist.

500 Internal Server Error: A problem occurred on the server.

Refer to the Error Handling Guide for more details on troubleshooting common errors.

Step 8: Next Steps

Now that you’ve successfully made your first API requests, you can start exploring more advanced features of the Everabyte API:

File Management: Upload, download, delete, and organize files and folders.

Metadata: Access and manage file metadata like tags and descriptions.

Permissions: Manage access to your files and folders with permissions.

To dive deeper into the API, check out our API Reference.

Conclusion

Congratulations! You’ve successfully completed the Everabyte Cloud Storage API Quickstart Guide. You’re now ready to integrate the API into your applications and automate your cloud storage management.

For more detailed information on all available endpoints and advanced features, visit our API Documentation.

Explanation of Key Sections:

Prerequisites: Lists everything the user needs to get started.

Step-by-Step Instructions: Walks the user through the steps to obtain an API key, make requests, upload files, list files, and download files using simple commands.

Error Handling: Mentions common errors and provides a link to the detailed error guide.

Next Steps: Encourages users to explore more advanced features of the API.

Conclusion: A final congratulatory note and a call to explore the documentation further.

This guide is designed to help users quickly start using the Everabyte Cloud Storage API and provides all the necessary instructions to interact with the API. You can link the placeholders like API Reference and API Documentation to the actual documentation pages when available.

Next Steps

Now that you're authenticated, you can:

Upload and Manage Files

Create and Manage Directories

Set Permissions and Access Controls

Use Plan-Specific Features

For detailed API endpoints and features specific to your storage plan, refer to our API Documentation.

Everabyte Cloud Storage API Quickstart Guide#

Introduction#

Prerequisites#

Authentication#

Authentication Request#

Successful Authentication Response#

Using Your Token#

Available Storage Plans#

Step 1: Obtain Your API Key#

Step 2: Set Up Your Environment#

Step 3: Make Your First API Request#

Example Request (using Curl):#

Expected Response:#

Step 4: Upload a File#

Example Request (using Curl):#

Expected Response:#

Step 5: List Files in Your Storage#

Example Request (using Curl):#

Expected Response:#

Step 6: Download a File#

Example Request (using Curl):#

Step 7: Handling Errors#

Step 8: Next Steps#

Conclusion#

Explanation of Key Sections:#

Next Steps#

Everabyte Cloud Storage API Quickstart Guide

Introduction

Prerequisites

Authentication

Authentication Request

Successful Authentication Response

Using Your Token

Available Storage Plans

Step 1: Obtain Your API Key

Step 2: Set Up Your Environment

Step 3: Make Your First API Request

Example Request (using Curl):

Expected Response:

Step 4: Upload a File

Example Request (using Curl):

Expected Response:

Step 5: List Files in Your Storage

Example Request (using Curl):

Expected Response:

Step 6: Download a File

Example Request (using Curl):

Step 7: Handling Errors

Step 8: Next Steps

Conclusion

Explanation of Key Sections:

Next Steps