Tutorial: Learn to Work with Files in GroupDocs.Parser Cloud

Learning Objectives

In this tutorial, you’ll learn how to:

Download files from cloud storage
Upload files to cloud storage
Delete files from storage
Copy files between locations
Move files to different paths

Prerequisites

Before you begin this tutorial, you need:

A GroupDocs Cloud account (if you don’t have one, register for free)
Your Client ID and Client Secret (available from the Dashboard)
Basic knowledge of REST APIs
Familiarity with your preferred programming language (C#, Java, or cURL)

Introduction

Efficient file management is essential when working with documents in the cloud. GroupDocs.Parser Cloud API provides comprehensive file operations that let you upload, download, copy, move, and delete files in your cloud storage. In this tutorial, we’ll explore how to perform these essential file operations to manage your documents effectively.

Step 1: Setting Up Your Environment

Before working with file operations, you need to set up authentication to access the GroupDocs.Parser Cloud API.

Try it yourself

Create a new project in your preferred development environment and add the required dependencies:

For C#:

// Install via NuGet:
// Install-Package GroupDocs.Parser-Cloud

For Java:

// Add to pom.xml:
// <dependency>
//     <groupId>com.groupdocs</groupId>
//     <artifactId>groupdocs-parser-cloud</artifactId>
//     <version>latest-version</version>
// </dependency>

Then authenticate with your Client ID and Client Secret:

// C# authentication example
string ClientId = "your-client-id";
string ClientSecret = "your-client-secret";
var configuration = new Configuration(ClientId, ClientSecret);

Step 2: Downloading Files from Cloud Storage

Let’s start by learning how to download files from your cloud storage.

Understanding the API

The Download File API allows you to retrieve a file from your GroupDocs Cloud Storage to your local environment.

Implementation Example

Here’s how to download files using different methods:

Using cURL

curl -X GET "https://api.groupdocs.cloud/v1.0/parser/storage/file/parserdocs/sample.docx?storageName=MyStorage" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer {access_token}" \
-o "downloaded_sample.docx"

Using C# SDK

// Create FileApi instance
var apiInstance = new FileApi(configuration);

// File path in the storage
string filePath = "parserdocs/sample.docx";
// Storage name
string storageName = "MyStorage";

// Call API to download file
var response = apiInstance.DownloadFile(new DownloadFileRequest(filePath, storageName));

// Save file to local disk
string localFilePath = "downloaded_sample.docx";
using (var fileStream = System.IO.File.Create(localFilePath))
{
    response.CopyTo(fileStream);
}

Console.WriteLine($"File downloaded to {localFilePath} successfully.");

Using Java SDK

// Create FileApi instance
FileApi apiInstance = new FileApi(configuration);

// File path in the storage
String filePath = "parserdocs/sample.docx";
// Storage name
String storageName = "MyStorage";

// Call API to download file
DownloadFileRequest request = new DownloadFileRequest(filePath, storageName);
File response = apiInstance.downloadFile(request);

// Process the downloaded file
System.out.println("File downloaded successfully.");
System.out.println("File size: " + response.length() + " bytes");

Try it yourself

Replace {access_token} with your actual token in the cURL example
Modify “parserdocs/sample.docx” to a file path in your storage
Run the code and check if the file is downloaded to your local environment

Step 3: Uploading Files to Cloud Storage

Now let’s learn how to upload files to your cloud storage.

Implementation Example

Using cURL

curl -X POST "https://api.groupdocs.cloud/v1.0/parser/storage/file/parserdocs/uploaded_document.docx?storageName=MyStorage" \
-H "accept: application/json" \
-H "authorization: Bearer {access_token}" \
-H "Content-Type: multipart/form-data" \
-F "file=@local_document.docx"

Using C# SDK

// Create FileApi instance
var apiInstance = new FileApi(configuration);

// Local file to upload
string localFilePath = "local_document.docx";
// Destination path in storage
string uploadPath = "parserdocs/uploaded_document.docx";
// Storage name
string storageName = "MyStorage";

// Prepare file content
var fileStream = System.IO.File.OpenRead(localFilePath);

// Call API to upload file
var response = apiInstance.UploadFile(new UploadFileRequest(uploadPath, fileStream, storageName));

// Check the result
if (response.Uploaded != null && response.Uploaded.Count > 0)
{
    Console.WriteLine("File uploaded successfully:");
    foreach (var file in response.Uploaded)
    {
        Console.WriteLine(file);
    }
}
else
{
    Console.WriteLine("File upload failed.");
}

Using Java SDK

// Create FileApi instance
FileApi apiInstance = new FileApi(configuration);

// Local file to upload
String localFilePath = "local_document.docx";
// Destination path in storage
String uploadPath = "parserdocs/uploaded_document.docx";
// Storage name
String storageName = "MyStorage";

// Prepare file content
File fileToUpload = new File(localFilePath);
FileInputStream fileStream = new FileInputStream(fileToUpload);

// Call API to upload file
UploadFileRequest request = new UploadFileRequest(uploadPath, fileStream, storageName);
FilesUploadResult response = apiInstance.uploadFile(request);

// Check the result
if (response.getUploaded() != null && response.getUploaded().size() > 0) {
    System.out.println("File uploaded successfully:");
    for (String file : response.getUploaded()) {
        System.out.println(file);
    }
} else {
    System.out.println("File upload failed.");
}

Expected Response

{
  "Uploaded": [
    "parserdocs/uploaded_document.docx"
  ],
  "Errors": []
}

Learning Checkpoint

Question: What happens if you upload a file to a path that already exists in your storage? Answer: If you upload a file to a path that already exists, the existing file will be overwritten with the new content. There is no automatic versioning, so make sure to use proper file naming or check for existence first if you want to prevent overwriting.

Step 4: Deleting Files from Storage

Let’s learn how to delete files from your cloud storage.

Implementation Example

Using cURL

curl -X DELETE "https://api.groupdocs.cloud/v1.0/parser/storage/file/parserdocs/document_to_delete.docx?storageName=MyStorage" \
-H "accept: application/json" \
-H "authorization: Bearer {access_token}"

Using C# SDK

// Create FileApi instance
var apiInstance = new FileApi(configuration);

// File path to delete
string filePath = "parserdocs/document_to_delete.docx";
// Storage name
string storageName = "MyStorage";
// Version ID (optional)
string versionId = null;

// Call API to delete file
apiInstance.DeleteFile(new DeleteFileRequest(filePath, storageName, versionId));

Console.WriteLine($"File '{filePath}' deleted successfully.");

Using Java SDK

// Create FileApi instance
FileApi apiInstance = new FileApi(configuration);

// File path to delete
String filePath = "parserdocs/document_to_delete.docx";
// Storage name
String storageName = "MyStorage";
// Version ID (optional)
String versionId = null;

// Call API to delete file
DeleteFileRequest request = new DeleteFileRequest(filePath, storageName, versionId);
apiInstance.deleteFile(request);

System.out.println("File '" + filePath + "' deleted successfully.");

Expected Response

{
  "Code": 200,
  "Status": "OK"
}

Step 5: Copying Files in Cloud Storage

Next, let’s learn how to copy files between locations in your cloud storage.

Implementation Example

Using cURL

curl -X PUT "https://api.groupdocs.cloud/v1.0/parser/storage/file/copy/parserdocs/source.docx?destPath=parserdocs/destination.docx&srcStorageName=MyStorage&destStorageName=MyStorage" \
-H "accept: application/json" \
-H "authorization: Bearer {access_token}"

Using C# SDK

// Create FileApi instance
var apiInstance = new FileApi(configuration);

// Source file path
string srcPath = "parserdocs/source.docx";
// Destination file path
string destPath = "parserdocs/destination.docx";
// Source storage name
string srcStorageName = "MyStorage";
// Destination storage name
string destStorageName = "MyStorage";
// Version ID (optional)
string versionId = null;

// Call API to copy file
apiInstance.CopyFile(new CopyFileRequest(srcPath, destPath, srcStorageName, destStorageName, versionId));

Console.WriteLine($"File copied from '{srcPath}' to '{destPath}' successfully.");

Using Java SDK

// Create FileApi instance
FileApi apiInstance = new FileApi(configuration);

// Source file path
String srcPath = "parserdocs/source.docx";
// Destination file path
String destPath = "parserdocs/destination.docx";
// Source storage name
String srcStorageName = "MyStorage";
// Destination storage name
String destStorageName = "MyStorage";
// Version ID (optional)
String versionId = null;

// Call API to copy file
CopyFileRequest request = new CopyFileRequest(srcPath, destPath, srcStorageName, destStorageName, versionId);
apiInstance.copyFile(request);

System.out.println("File copied from '" + srcPath + "' to '" + destPath + "' successfully.");

Expected Response

{
  "Code": 200,
  "Status": "OK"
}

Step 6: Moving Files in Cloud Storage

Finally, let’s learn how to move files between locations in your cloud storage.

Implementation Example

Using cURL

curl -X PUT "https://api.groupdocs.cloud/v1.0/parser/storage/file/move/parserdocs/source.docx?destPath=parserdocs/moved.docx&srcStorageName=MyStorage&destStorageName=MyStorage" \
-H "accept: application/json" \
-H "authorization: Bearer {access_token}"

Using C# SDK

// Create FileApi instance
var apiInstance = new FileApi(configuration);

// Source file path
string srcPath = "parserdocs/source.docx";
// Destination file path
string destPath = "parserdocs/moved.docx";
// Source storage name
string srcStorageName = "MyStorage";
// Destination storage name
string destStorageName = "MyStorage";
// Version ID (optional)
string versionId = null;

// Call API to move file
apiInstance.MoveFile(new MoveFileRequest(srcPath, destPath, srcStorageName, destStorageName, versionId));

Console.WriteLine($"File moved from '{srcPath}' to '{destPath}' successfully.");

Using Java SDK

// Create FileApi instance
FileApi apiInstance = new FileApi(configuration);

// Source file path
String srcPath = "parserdocs/source.docx";
// Destination file path
String destPath = "parserdocs/moved.docx";
// Source storage name
String srcStorageName = "MyStorage";
// Destination storage name
String destStorageName = "MyStorage";
// Version ID (optional)
String versionId = null;

// Call API to move file
MoveFileRequest request = new MoveFileRequest(srcPath, destPath, srcStorageName, destStorageName, versionId);
apiInstance.moveFile(request);

System.out.println("File moved from '" + srcPath + "' to '" + destPath + "' successfully.");

Expected Response

{
  "Code": 200,
  "Status": "OK"
}

Troubleshooting Tips

If you encounter issues while working with file operations, consider these common solutions:

File Not Found Errors: Ensure that the file path is correct and the file exists. Use the Object Exists API to check.
Permission Errors: Verify that your account has the necessary permissions for the specified storage.
Invalid File Types: Ensure that the file type is supported by GroupDocs.Parser Cloud.
Destination Already Exists: When copying or moving files, check if the destination already exists to avoid unexpected overwrites.

What You’ve Learned

In this tutorial, you’ve learned how to:

Download files from cloud storage to your local environment
Upload local files to your cloud storage
Delete files from your storage when they’re no longer needed
Copy files between different locations in the cloud
Move files to reorganize your document storage

These file operations are essential for effectively managing your documents in the cloud with GroupDocs.Parser.

Further Practice

To reinforce your learning, try these exercises:

Create a batch file uploader that uploads multiple files at once
Build a simple file synchronization tool that compares local and cloud files
Implement a file backup system that copies important files to a backup folder

Tutorial: Learn to Work with Files in GroupDocs.Parser Cloud

Learning Objectives

Prerequisites

Introduction

Step 1: Setting Up Your Environment

Try it yourself

Step 2: Downloading Files from Cloud Storage

Understanding the API

Implementation Example

Using cURL

Using C# SDK

Using Java SDK

Try it yourself

Step 3: Uploading Files to Cloud Storage

Implementation Example

Using cURL

Using C# SDK

Using Java SDK

Expected Response

Learning Checkpoint

Step 4: Deleting Files from Storage

Implementation Example

Using cURL

Using C# SDK

Using Java SDK

Expected Response

Step 5: Copying Files in Cloud Storage

Implementation Example

Using cURL

Using C# SDK

Using Java SDK

Expected Response

Step 6: Moving Files in Cloud Storage

Implementation Example

Using cURL

Using C# SDK

Using Java SDK

Expected Response

Troubleshooting Tips

What You’ve Learned

Further Practice

Helpful Resources