Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

WebP Converter Android SDK

WebP Converter transforms WebP images to classic formats like PNG and JPG, or converts other formats to WebP for better compression. Essential for handling modern web images.

License: MIT Platform Java


Installation

Gradle (via JitPack)

Add JitPack repository to your root build.gradle:

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Add the dependency:

dependencies {
    implementation 'com.github.apiverve:webpconverter-api:1.1.14'
}

Quick Start

Basic Usage

import com.apiverve.webpconverter.WebPConverterAPIClient;
import com.apiverve.webpconverter.APIResponse;
import com.apiverve.webpconverter.APIException;

// Initialize the client
WebPConverterAPIClient client = new WebPConverterAPIClient("YOUR_API_KEY");

try {
    // Prepare request parameters
    Map<String, Object> parameters = new HashMap<>();
    parameters.put("image", "example");
    parameters.put("outputFormat", "png");
    parameters.put("quality", 90);
    parameters.put("maxWidth", 1920);
    parameters.put("maxHeight", 1080);

    // Execute the request
    APIResponse response = client.execute(parameters);

    if (response.isSuccess()) {
        // Handle successful response
        JSONObject data = response.getData();
        System.out.println("Success: " + data.toString());
    } else {
        // Handle API error
        System.err.println("API Error: " + response.getError());
    }
} catch (APIException e) {
    // Handle exception
    e.printStackTrace();
}

Without Parameters

// Some APIs don't require parameters
APIResponse response = client.execute();

File Upload

This API requires a file upload. Supported file types: .webp, .png, .jpg, .jpeg, .gif (max 10MB)

import java.io.File;

// Upload an image file
File imageFile = new File("/path/to/image.jpg");
APIResponse response = client.executeWithFile(imageFile, "image");

if (response.isSuccess()) {
    JSONObject data = response.getData();
    System.out.println("Success: " + data.toString());
}

Note: File uploads use multipart/form-data encoding. Ensure your file size does not exceed 10MB.


Error Handling

The SDK provides detailed error handling:

try {
    APIResponse response = client.execute(parameters);

    if (response.isSuccess()) {
        // Process success
    } else {
        // Handle API-level errors
        System.err.println("Error: " + response.getError());
    }
} catch (APIException e) {
    if (e.isAuthenticationError()) {
        System.err.println("Invalid API key");
    } else if (e.isRateLimitError()) {
        System.err.println("Rate limit exceeded");
    } else if (e.isServerError()) {
        System.err.println("Server error");
    } else {
        System.err.println("Error: " + e.getMessage());
    }
}

Response Object

The APIResponse object provides several methods:

APIResponse response = client.execute(params);

// Check status
boolean success = response.isSuccess();
boolean error = response.isError();

// Get data
String status = response.getStatus();
String errorMsg = response.getError();
JSONObject data = response.getData();
int code = response.getCode();

// Get raw response
JSONObject raw = response.getRawResponse();

API Documentation

For detailed API documentation, visit: https://docs.apiverve.com/ref/webpconverter


Get Your API Key

Get your API key from https://apiverve.com


Requirements

  • Java 8 or higher
  • Android API level 21 (Lollipop) or higher

Support


License

This SDK is released under the MIT License. See LICENSE for details.


About APIVerve

APIVerve provides production-ready REST APIs for developers. Fast, reliable, and easy to integrate.