API Documentation

Overview

Welcome to NextGen Convert, a platform that supports WebP (and soon AVIF) conversion.

Data Processing Scope and Purpose

Our API-accessible service processes uploaded files solely for service delivery and statistical purposes related to service delivery. This includes the collection of IP addresses for analysis and prevention, image data for the use of compression analysis, as well as the use of email addresses for account-related communication and marketing.

Ephemeral Image Storage, Security, and Data Protection

Uploaded images are stored during service provision, although temporarily, to ensure data protection. We do not create backups. It's important to consider uploaded images as public. This service is to be used with publicly accessible images. While we take steps to secure your data, we cannot guarantee absolute file security. Use our service at your own risk. Files are automatically deleted within 24 hours (typically sooner) of upload for security reasons. This service should not be used with images that are not intended to be publicly accessible.

Automation, User Control, and Data Collection

Our image processing is fully automated, minimizing human interaction. Periodically, we review images for compression quality and compliance with our terms. Data may be accessed, inspected, or extracted from your files to enhance our service. It is essential to keep copies of your files, as we are not liable for disruptions caused by files sent to us. We assume no responsibility for loss of use, data, goodwill, or profits, whether foreseeable or not. We do not accept liability for any special, incidental, indirect, consequential, or punitive damages arising from claims related to your use of our service. We collect additional data such as the number of converted files, error occurrences, and total file sizes of your conversions. We log your IP address for preventing misuse and general demographic analysis, and it is not connected to personally identifiable information.

Damages

We do not accept liability for any damages resulting from the use of our service. We cannot guarantee the integrity, safety, or retention of your files.

Please be aware that our policies may change. It is advisable to check periodically for updates.

API Key Management

To obtain an API key, please visit nextgenconvert.com and register for the service. Your API key is essential for accessing our API and should be kept secure at all times.

If you need to regenerate your API key, you will need to cancel your current subscription Stripe Customer Portal and then resubscribe to our service. This process will automatically generate a new API key for you but you will be charged again.

API Flow

sequenceDiagram participant U as User participant UD as User Domain participant W as API participant S as Server U->>W: Register for Service W->>S: Process Registration S->>U: Provide API Key U->>W: Send Image Conversion Request (with API Key and Image URL) W->>S: Validate Request and API Key S->>UD: Request to Download Public Image alt Image Download Success UD->>S: Respond with Image File S->>S: Convert Image to WebP Format S->>U: Return Success Response with Next Generation Image Path else Image Download Error S->>U: Return Error Response (Image Download Failed) end alt Conversion Success U->>W: Request to Download Converted Image W->>S: Request Converted Image File S->>W: Provide Image File W->>U: User Downloads and Saves Image else Conversion Error U->>W: Adjust Request and Retry end note over S: Ephemeral Image Cleanup

API Rate Limiting

Our API implements a rate limiting system to ensure fair paid usage. Each product tier has a specified maximum number of requests that can be made within a fixed one-hour time window. This rate limiting is tied to your API key and is calculated based on the number of requests you made in the last hour. Once you reach your limit, you will be able to make new requests again as soon as the oldest requests in that one-hour window fall outside of this period. Below is a breakdown of the request limits for each product tier.

Product Tier	Max Requests	Window Duration (Hours)
Standard	3600	1.0

Convert Endpoint

POST: https://api.nextgenconvert.com/api/v1.0/convert Content-Type: application/json

Request Example

curl -X POST http://localhost:5000 -H "Content-Type: application/json" -d '{
    "auth": "your-auth-token",
    "url": "https://example.com/image.jpg",
    "quality": 80
}'

Successful Response Example

{
  "status": "success",
  "convert_path": "/converted/somehash.webp"
}

Erroring Response Example

{
  "status":"error",
  "errors":["No 'url' request body parameter provided"]
}

Errors

Path	Method	Error Message	Error Type	Status Code
/api/*	GET	Method Not Allowed	methodNotAllowed	405
/api/*	POST	API version not implemented	ApiVersionError	501

Path	Method	Error Message	Error Type	Status Code
/api/v1.0/convert	POST	Your request body is missing	BadRequest	400
/api/v1.0/convert	POST	No 'url' request body parameter provided	ParameterError	400
/api/v1.0/convert	POST	Invalid 'url' request body parameter format	ParameterError	400
/api/v1.0/convert	POST	Invalid authentication 'auth' request body parameter provided for: [domain]	AuthError	401
/api/v1.0/convert	POST	No authentication 'auth' request body parameter provided	ParameterError	401
/api/v1.0/convert	POST	Invalid 'quality' request body parameter. It must be a number between 0 and 100	ParameterError	422
/api/v1.0/convert	POST	Too many requests, please try again later.	rateLimitExceeded	429

Converted Endpoint

Url provided by Convert Enpoint response

GET: https://api.nextgenconvert.com/converted/*

Request Example

curl -X GET "http://localhost:5000/converted-path?auth=your-auth-token"

Successful Response Example

Next Gen Image Binary Data

Erroring Response Example

{
  "status":"error",
  "errors":[No authentication 'auth' request body parameter provided]
}

Errors

Path	Method	Error Message	Error Type	Status Code
/converted/*	GET	Invalid authentication 'auth' request body parameter provided for access to converted image	AuthError	401
/converted/*	GET	No authentication 'auth' request body parameter provided	ParameterError	401
/converted/*	GET	Converted file not found	NotFoundError	404
/converted/*	POST	Method Not Allowed	methodNotAllowed	405
/converted/*	GET	Very recently deleted	NotFoundError	410

Terms of Service

1. Acceptance of Terms

By using NextGenConvert.com's service, you agree to abide by the following terms and conditions. If you do not agree with these terms, please refrain from using our service.

2. User Responsibilities

You are responsible for ensuring that any content you upload or request to be converted does not violate any applicable laws. You must not use our service to convert or distribute unlawful, offensive, or infringing content.

3. Intellectual Property

All intellectual property rights associated with the content uploaded or converted using our service remain the property of their respective owners. You may not use the converted content in any way that infringes upon the intellectual property rights of others.

4. Service Usage

You agree to use our service in compliance with all relevant laws and regulations. You must not engage in any malicious activities, including attempting to disrupt or harm our service.

5. Termination

We reserve the right to terminate your access to our service at our discretion, with or without cause. Termination may result from violating these terms or engaging in activities that disrupt the service or harm other users.

6. Liability

We make every effort to provide a reliable service, but we do not accept liability for any damages, including but not limited to loss of use, data, goodwill, profits, or any other indirect or consequential damages resulting from your use of our service.

7. Dispute Resolution

In the event of any dispute arising from or relating to these terms or your use of our service, both parties agree to attempt to resolve the dispute through negotiation and good-faith discussions. If a resolution cannot be reached, any legal actions will be subject to the jurisdiction and laws of the United Kingdom.

8. Refund Policy

Refunds for subscription fees are only applicable to the current billing month. If you wish to request a refund for the current month's subscription fee, please contact our customer support within 7 days from the date of your subscription renewal. Refund requests made after this period will not be eligible for consideration. We do not provide refunds for any previous months' subscription fees, and refunds are not available for any additional services or charges incurred during your subscription period. Please note that any request for a refund will result in the immediate termination of your subscription, and you will lose access to our service for the remainder of the billing month.

Privacy Policy

Effective Date: 01/01/2024

1. Introduction

Welcome to NextGenConvert.com ("us," "we," "our," or "Company"). We are committed to protecting your privacy and ensuring the security of your personal information. This Privacy Policy explains how we collect, use, disclose, and safeguard your personal data when you use our services, including our website and any associated applications (collectively, the "Service").

2. Information We Collect

We may collect various types of information when you use our Service, including:

2.1. Personal Information: Name, Email address, Contact information, Account credentials (e.g., username, password)

2.2. Usage Information: IP address, Device and browser information, Log data (e.g., access times, pages viewed)

2.3. Content Data: Files and content uploaded to our Service

3. How We Use Your Information

We may use the information collected for the following purposes:

3.1. Service Delivery: to provide and maintain our Service, To process and complete transactions, to authenticate and authorize users

3.2. Communication: to communicate with you regarding your account, updates, and support, to respond to your requests, comments, or questions

3.3. Analytics and Improvement: to analyse and improve the Service, To monitor usage patterns and trends

4. Information Sharing

We may share your information with third parties under the following circumstances:

4.1. Service Providers: to third-party service providers who assist us in delivering and maintaining our Service

4.2. Legal Compliance: to comply with legal obligations, court orders, or government requests, to protect our rights, privacy, safety, or property

5. Data Security

We implement appropriate technical and organizational measures to protect your personal information. However, no data transmission or storage can be guaranteed to be 100% secure. We cannot guarantee the absolute security of your data.

6. Your Choices

You have the right to:

6.1. Access, Correct, or Delete Your Information: you can access, correct, or delete your personal information by contacting us.

6.2. Opt-Out: you can opt-out of receiving promotional emails from us by following the instructions in the email.

7. Changes to this Privacy Policy

We may update this Privacy Policy periodically to reflect changes in our practices. We will notify you of any significant changes by posting the revised policy on our website.

8. Contact Us

If you have questions, concerns, or requests regarding this Privacy Policy, please contact us at contact@nextgenconvert.com.