Tài liệu dành cho nhà phát triển vectơ hóa hình ảnh

Vectorizer.AI cung cấp SDK chính thức, ứng dụng khách dòng lệnh, thông số kỹ thuật OpenAPI và API theo dõi bitmap chính thức. Tất cả các công cụ dành cho nhà phát triển này đều sử dụng cùng một dịch vụ để theo dõi các pixel thành vectơ hoàn toàn tự động và với độ trung thực tốt nhất trong phân khúc.

Khởi động nhanh API trực tiếp

Đối với tích hợp HTTP trực tiếp, POST một hình ảnh bitmap và nhận lại kết quả vectơ hóa:

• File
• URL

$ curl https://vi.vectorizer.ai/api/v1/vectorize \
 -u xyz123:[secret] \
 -F image=@example.jpeg \
 -o result.svg

// Requires: org.apache.httpcomponents.client5:httpclient5-fluent

Request request = Request.post("https://vi.vectorizer.ai/api/v1/vectorize")
   .addHeader("Authorization", "Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd")
   .body(
      MultipartEntityBuilder.create()
         .addBinaryBody("image", new File("example.jpeg")) // TODO: Replace with your image
         // TODO: Add more upload parameters here
         .build()
      );
ClassicHttpResponse response = (ClassicHttpResponse) request.execute().returnResponse();

if (response.getCode() == 200) {
   // Write result to disk, TODO: or wherever you'd like
   try (FileOutputStream out = new FileOutputStream("result.svg")) {
      response.getEntity().writeTo(out);
   }
} else {
   System.out.println("Request Failed: Status: " + response.getCode() + ", Reason: " + response.getReasonPhrase());
}

using (var client = new HttpClient())
using (var form = new MultipartFormDataContent())
{
   client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "INSERT_API_KEY_HERE");
   form.Add(new ByteArrayContent(File.ReadAllBytes("example.jpeg")), "image", "example.jpeg"); // TODO: Replace with your image
   // TODO: Add more upload parameters here

   var response = client.PostAsync("https://vi.vectorizer.ai/api/v1/vectorize", form).Result;

   if (response.IsSuccessStatusCode)
   {
      // Write result to disk, TODO: or wherever you'd like
      FileStream outStream = new FileStream("result.svg", FileMode.Create, FileAccess.Write, FileShare.None);
      response.Content.CopyToAsync(outStream).ContinueWith((copyTask) => { outStream.Close(); });
   }
   else
   {
       Console.WriteLine("Request Failed: Status: " + response.StatusCode + ", Reason: " + response.ReasonPhrase);
   }
}

// Requires "request" to be installed (see https://www.npmjs.com/package/request)
var request = require('request');
var fs = require('fs');

request.post({
  url: 'https://vi.vectorizer.ai/api/v1/vectorize',
  formData: {
    image: fs.createReadStream('example.jpeg'), // TODO: Replace with your image
    // TODO: Add more upload options here
  },
  auth: {user: 'xyz123', pass: '[secret]'},
  followAllRedirects: true,
  encoding: null
}, function(error, response, body) {
  if (error) {
    console.error('Request failed:', error);
  } else if (!response || response.statusCode != 200) {
    console.error('Error:', response && response.statusCode, body.toString('utf8'));
  } else {
    // Save result
    fs.writeFileSync("result.svg", body);
  }
});

$ch = curl_init('https://vi.vectorizer.ai/api/v1/vectorize');

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Authorization: Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd'));
curl_setopt($ch, CURLOPT_POSTFIELDS,
    array(
      'image' => curl_file_create('example.jpeg'),
      // TODO: Add more upload options here
    ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) == 200) {
  // Save result
  file_put_contents("result.svg", $data);
} else {
  echo "Error: " . $data;
}
curl_close($ch);

# Either use the sample code below, or the official SDK: https://vectorizer.ai/api/documentation#sdks
# Requires "requests" to be installed (see https://pypi.org/project/requests/)
import requests

response = requests.post(
    'https://vi.vectorizer.ai/api/v1/vectorize',
    files={'image': open('example.jpeg', 'rb')},
    data={
        # TODO: Add more upload options here
    },
    auth=('xyz123', '[secret]')
)
if response.status_code == requests.codes.ok:
    # Save result
    with open('result.svg', 'wb') as out:
        out.write(response.content)
else:
    print("Error:", response.status_code, response.text)

# Requires: gem install httpclient
require 'httpclient'

client = HTTPClient.new default_header: {
  "Authorization" => "Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd"
}

response = client.post("https://vi.vectorizer.ai/api/v1/vectorize", {
  "image" => File.open("example.jpeg", "rb"), # TODO: Replace with your image
  # TODO: Add more upload parameters here
})

if response.status == 200 then
  # Write result to disk, TODO: or wherever you'd like
  File.open("result.svg", 'w') { |file| file.write(response.body) }
else
  puts "Error: Code: " + response.status.to_s + ", Reason: " + response.reason
end

$ curl https://vi.vectorizer.ai/api/v1/vectorize \
 -u xyz123:[secret] \
 -F 'image.url=https://example.com/example.jpeg' \
 -o result.svg

// Requires: org.apache.httpcomponents.client5:httpclient5-fluent

Request request = Request.post("https://vi.vectorizer.ai/api/v1/vectorize")
   .addHeader("Authorization", "Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd")
   .body(
      MultipartEntityBuilder.create()
         .addTextBody("image.url", "https://example.com/example.jpeg") // TODO: Replace with your image URL
         // TODO: Add more upload parameters here
         .build()
      );
ClassicHttpResponse response = (ClassicHttpResponse) request.execute().returnResponse();

if (response.getCode() == 200) {
   // Write result to disk, TODO: or wherever you'd like
   try (FileOutputStream out = new FileOutputStream("result.svg")) {
      response.getEntity().writeTo(out);
   }
} else {
   System.out.println("Request Failed: Status: " + response.getCode() + ", Reason: " + response.getReasonPhrase());
}

using (var client = new HttpClient())
using (var form = new MultipartFormDataContent())
{
   client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", "INSERT_API_KEY_HERE");
   form.Add(new StringContent("https://example.com/example.jpeg"), "image.url"); // TODO: Replace with your image URL
   // TODO: Add more upload parameters here

   var response = client.PostAsync("https://vi.vectorizer.ai/api/v1/vectorize", form).Result;

   if (response.IsSuccessStatusCode)
   {
      // Write result to disk, TODO: or wherever you'd like
      FileStream outStream = new FileStream("result.svg", FileMode.Create, FileAccess.Write, FileShare.None);
      response.Content.CopyToAsync(outStream).ContinueWith((copyTask) => { outStream.Close(); });
   }
   else
   {
       Console.WriteLine("Request Failed: Status: " + response.StatusCode + ", Reason: " + response.ReasonPhrase);
   }
}

// Requires "request" to be installed (see https://www.npmjs.com/package/request)
var request = require('request');
var fs = require('fs');

request.post({
  url: 'https://vi.vectorizer.ai/api/v1/vectorize',
  formData: {
    'image.url': 'https://example.com/example.jpeg', // TODO: Replace with your image
    // TODO: Add more upload options here
  },
  auth: {user: 'xyz123', pass: '[secret]'},
  followAllRedirects: true,
  encoding: null
}, function(error, response, body) {
  if (error) {
    console.error('Request failed:', error);
  } else if (!response || response.statusCode != 200) {
    console.error('Error:', response && response.statusCode, body.toString('utf8'));
  } else {
    // Save result
    fs.writeFileSync("result.svg", body);
  }
});

$ch = curl_init('https://vi.vectorizer.ai/api/v1/vectorize');

curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Authorization: Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd'));
curl_setopt($ch, CURLOPT_POSTFIELDS,
    array(
      'image.url' => 'https://example.com/example.jpeg',
      // TODO: Add more upload options here
    ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

$data = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) == 200) {
  // Save result
  file_put_contents("result.svg", $data);
} else {
  echo "Error: " . $data;
}
curl_close($ch);

# Either use the sample code below, or the official SDK: https://vectorizer.ai/api/documentation#sdks
# Requires "requests" to be installed (see https://pypi.org/project/requests/)
import requests

response = requests.post(
    'https://vi.vectorizer.ai/api/v1/vectorize',
    data={
        'image.url': 'https://example.com/example.jpeg',
        # TODO: Add more upload options here
    },
    auth=('xyz123', '[secret]')
)
if response.status_code == requests.codes.ok:
    # Save result
    with open('result.svg', 'wb') as out:
        out.write(response.content)
else:
    print("Error:", response.status_code, response.text)

# Requires: gem install httpclient
require 'httpclient'

client = HTTPClient.new default_header: {
  "Authorization" => "Basic dmt5YzY3a3FhMjd5aWRkOltzZWNyZXRd"
}

response = client.post("https://vi.vectorizer.ai/api/v1/vectorize", {
  "image.url" => "https://example.com/example.jpeg", # TODO: Replace with your image URL
  # TODO: Add more upload parameters here
})

if response.status == 200 then
  # Write result to disk, TODO: or wherever you'd like
  File.open("result.svg", 'w') { |file| file.write(response.body) }
else
  puts "Error: Code: " + response.status.to_s + ", Reason: " + response.reason
end

Nhà phát triển Chatbot

Chúng tôi đã tạo một ChatGPT tùy chỉnh có thể giúp tích hợp nhà phát triển Vectorizer.AI trên SDK, dòng lệnh, OpenAPI và API HTTP trực tiếp. Nó có thể trả lời các câu hỏi về các tài liệu này và cung cấp mã mẫu hoặc lệnh bằng ngôn ngữ ưa thích của bạn phù hợp với trường hợp sử dụng của bạn.

Chatbot đang trong giai đoạn beta và mắc lỗi. Kiểm tra kỹ các câu trả lời và yêu cầu nó sửa đổi mã để sửa lỗi và thiếu sót.

SDK

SDK chính thức được tạo từ đặc tả OpenAPI công khai và sử dụng xác thực HTTP Basic giống như các lệnh gọi API trực tiếp. Chúng là điểm khởi đầu được đề xuất cho hầu hết các tích hợp ứng dụng và các cuộc gọi vectơ hóa và tải xuống của chúng trả về nội dung tệp trong khi các cuộc gọi tài khoản và xóa trả về các mô hình JSON.

Tất cả SDK đều nhắm mục tiêu https://api.vectorizer.ai/api/v1 và là bao bọc xung quanh các điểm cuối /vectorize, /download, /delete và /account ổn định.

Ưu tiên SDK để tích hợp ứng dụng. Đối với trình tạo tùy chỉnh, ngôn ngữ không được hỗ trợ hoặc hoạt động giao thức trực tiếp, hãy sử dụng đặc tả OpenAPI. Cấu hình trình tạo có sẵn trên GitHub.

Tải xuống bản kê khai công cụ khách hàng

Dòng lệnh

Máy khách dòng lệnh chính thức là một tệp thực thi độc lập cho Windows, macOS và Linux. Nó dành cho shell, tập lệnh, xử lý hàng loạt, quy trình làm việc QA và người dùng muốn vectơ hóa hình ảnh mà không cần viết mã ứng dụng.

Sử dụng các liên kết tải xuống trực tiếp bên dưới cho bản phát hành hiện tại. Tất cả các tệp phát hành và tổng kiểm tra cũng có sẵn trên GitHub Releas es hoặc bạn có thể xem nguồn trên GitHub. CLI sử dụng thông tin đăng nhập API, máy chủ và hành vi điểm cuối giống như các cuộc gọi API trực tiếp và tích hợp SDK.

export VECTORIZER_API_ID="your-api-id"
export VECTORIZER_API_SECRET="your-api-secret"

vectorizer vectorize logo.png -o logo.svg
vectorizer vectorize logo.png -o logo.pdf --format pdf
vectorizer download IMAGE_TOKEN -o logo.svg

Sử dụng SDK khi nhúng Vectorizer.AI vào ứng dụng và sử dụng máy khách dòng lệnh khi giao diện tự nhiên là thiết bị đầu cuối, công việc đã lên lịch hoặc đường ống xử lý tệp.

Đặc điểm kỹ thuật OpenAPI

API trực tiếp có sẵn dưới dạng đặc tả OpenAPI 3.0 cho các máy khách được tạo, xác thực lược đồ và khám phá API. Đặc điểm kỹ thuật tương tự cũng thúc đẩy quy trình làm việc tạo SDK chính thức.

Đặc điểm kỹ thuật khai báo https://api.vectorizer.ai/api/v1 là máy chủ của nó, vì vậy các máy khách được tạo sử dụng các đường dẫn điểm cuối như /vectorize, /download, /delete và /account.

Quy trình công việc tích hợp

Các quy trình công việc này áp dụng cho dù bạn sử dụng SDK chính thức, ứng dụng khách dòng lệnh hoặc API HTTP trực tiếp. Dưới đây là một vài cái phổ biến:

Hình ảnh duy nhất Gửi bitmap, nhận kết quả vector, hoàn thành

Gọi trực tiếp quy trình làm việc Vectorize, thông qua SDK hoặc với ứng dụng khách dòng lệnh.

Xem trước đầu tiên Hiển thị bản xem trước cho khách hàng tiềm năng của bạn trước khi họ mua

Nếu bạn cần thực hiện nhiều cuộc gọi dịch vụ để bán hàng, bạn có thể sử dụng các bản xem trước chi phí thấp hơn cho đến khi bạn thực sự chuyển đổi một khách hàng.

1. Gọi Vectorize thông qua SDK, ứng dụng khách dòng lệnh hoặc HTTP trực tiếp với mode=preview và policy.retention_days > 0 để xem trước, đảm bảo giữ lại Mã thông báo hình ảnh được trả về trong tiêu đề phản hồi X-Image-Token.

2. Sau khi chuyển đổi, hãy gọi Tải xuống với Mã thông báo hình ảnh để tải xuống kết quả đầy đủ.

3. Tùy chọn: nếu bạn cần định dạng kết quả bổ sung (ví dụ: PNG, PDF, v.v.), hãy đảm bảo giữ lại Biên nhận được trả về trong tiêu đề phản hồi tải xuống X-Receipt. Sau đó sử dụng quy trình làm việc Tải xuống với Mã thông báo hình ảnh và Biên nhận để tải xuống các định dạng còn lại.

Đa định dạng Bạn cần ví dụ: cả kết quả PNG và SVG

1. Gọi Vectorize với policy.retention_days > 0 để nhận kết quả đầu tiên, đảm bảo giữ lại Mã thông báo hình ảnh được trả về trong tiêu đề phản hồi X-Image-Token.

2. Gọi Tải xuống bằng Mã thông báo hình ảnh để tải xuống các định dạng khác.

Đa Tùy chọn Bạn cần xử lý từng hình ảnh với nhiều tùy chọn xử lý

1. Gọi Vectorize với policy.retention_days > 0 để nhận kết quả đầu tiên, đảm bảo giữ lại Mã thông báo hình ảnh được trả về trong tiêu đề phản hồi X-Image-Token.

2. Gọi Vectorize với Image Token để lặp lại các tùy chọn xử lý còn lại mà bạn cần.

Ngoài ra, bạn có thể xử lý từng hình ảnh riêng lẻ và không lo lắng về Mã thông báo hình ảnh. Image Token giúp bạn tiết kiệm một chút băng thông và độ trễ.

Giá

Vui lòng xem trang giá cho gói đăng ký.

Xác Thực & Bảo Mật

API sử dụng xác thực truy cập cơ bản HTTP tiêu chuẩn. Tất cả các yêu cầu đối với API phải được thực hiện qua HTTPS và bao gồm API của bạn. Các chứng nhận, có Id API là người dùng và Bí mật API là mật khẩu.

SDK chính thức và ứng dụng khách dòng lệnh sử dụng các thông tin đăng nhập tương tự và thêm tiêu đề xác thực HTTP Basic cho bạn.

Thư viện khách hàng http của bạn phải hỗ trợ Chỉ Định Tên Máy Chủ (SNI) để thực hiện thành công các yêu cầu. Nếu bạn nhận được các lỗi giao tiếp lạ, việc thiếu hỗ trợ SNI có thể chính là lý do.

Giới Hạn Tốc Độ

Việc sử dụng API bị giới hạn tốc độ với các hạn mức cho phép mang tính hào phóng và không có giới hạn trần vượt.

Trong quá trình hoạt động thông thường do người dùng cuối điều khiển, bạn sẽ ít gặp phải bất kỳ giới hạn tốc độ nào vì việc sử dụng có xu hướng tăng giảm theo cách mà dịch vụ xử lý một cách ổn thoả.

Dù vậy, đối với các công việc hàng loạt chúng tôi khuyến khích bắt đầu nhiều nhất là 5 chuỗi, tăng thêm 1 chuỗi mới mỗi 5 phút cho đến khi bạn đạt đến mức độ song song mong muốn. Nếu bạn cần hơn 100 chuỗi cùng lúc, vui lòng liên hệ trước khi bắt đầu.

Cách dễ nhất để thực hiện sự gia tăng dần dần về tính song song này là bắt đầu nhanh chóng số lượng luồng mà cuối cùng bạn muốn sử dụng, nhưng sau đó sử dụng ký hiệu đếm bắt đầu với 5 phép. Sau đó, bạn có thể có một chủ đề riêng làm tăng số lượng giấy phép thêm 1 cứ sau 5 phút.

Nếu bạn gửi quá nhiều yêu cầu thì bạn sẽ bắt đầu nhận các phản hồi 429 Too Many Requests. Khi điều này xảy ra, bạn nên áp dụng linear back off//: trước phản hồi đầu tiên đó, đợi 5 giây cho đến khi gửi yêu cầu tiếp theo. Đối với 429 phản hồi liên tục thứ hai/, hãy đợi 2*5= 10 giây cho đến khi gửi yêu cầu tiếp theo. Đối với thứ bạ, đợi 3*5=15 giây, v.v.

Bạn có thể đặt lại bộ đếm back off sau khi yêu cầu thành công và bạn nên sử dụng back off trên cơ sở mỗi chuỗi (chẳng hạn các chuỗi nên hoạt động độc lập với nhau).

Thời gian chờ

Trong khi các yêu cầu của API thông thường được nhanh chóng làm xong, có thể trong suốt thời gian đột ngột tăng hoặc giảm tải tạm thời của người dùng đê trải nghiệm thời gian xử lý lâu hơn.

Nhằm để đảm bảo thư viện khách hàng của bạn không chấm dứt các yêu cầu API trước thời hạn, nên cấu hình có thời gian chờ không hoạt động ít nhất 180giây

Ứng dụng khách dòng lệnh chính thức mặc định ở thời gian chờ dài hơn, nhưng SDK tùy chỉnh và tích hợp HTTP trực tiếp vẫn nên đặt thời gian chờ thích hợp một cách rõ ràng.

Lỗi JSON

Chúng tôi sử dụng nguyên trạng HTTP quy ước để cho thấy sự thành công hay thất bại của một yêu cầu API và bao gồm những thông tin lỗi quan trọng trong Đối tượng Lỗi JSON (Error JSON Object) được trả về.

Chúng tôi luôn cố gắng trả về Đối tượng Lỗi JSON (Error JSON Object) với bất kỳ yêu nào có vấn đề. Tuy nhiên, có những thất bại của máy chủ nội bộ luôn luôn có thể về mặt lý thuyết mà việc đó dẫn đến phản hồi không không phải do lỗi JSON.

Nếu trạng thái HTTP đối với yêu cầu của bạn là 200 thì sẽ không có Đối Tượng Lỗi JSON (Error JSON Object) nào được trả về và bạn có thể giả định một cách an toàn nói chung là yêu cầu đã thành công/.

Một số Thư Viện Khách Hàng HTTP đưa ra các lỗi/ về nguyên trạng HTTP/ trong phạm vi 400-599. Bạn sẽ cần nắm lấy các lỗi này và xử lý chúng phù hợp.

SDK hiển thị các phản hồi không thành công này dưới dạng ngoại lệ gốc hoặc giá trị lỗi, trong khi máy khách dòng lệnh in chi tiết lỗi API thành lỗi tiêu chuẩn.

{
  "error" : {
    "status" : 400,
    "code" : 1006,
    "message" : "Failed to read the supplied image. "
  }
}

Lỗi API gần đây được liệt kê trên trang tài khoản của bạn để tiện cho bạn gỡ lỗi.

Cũng có một danh sách tất cả các phản ứng lỗi được API trả về .

Các Tiêu Đề Phản Hồi

Dưới đây là các tiêu đề phản hồi tùy chỉnh mà chúng tôi sử dụng:

Khi sử dụng SDK, hãy sử dụng biến thể phương thức nhận biết tiêu đề nếu bạn cần Mã thông báo hình ảnh, Biên nhận, thông tin tín dụng hoặc tiêu đề thử lại. Khi sử dụng ứng dụng khách dòng lệnh, Mã thông báo hình ảnh và Biên nhận được in đến lỗi tiêu chuẩn để đầu ra nhị phân vẫn có thể được ghi vào đầu ra tiêu chuẩn.

#00000000;
#FFFFFF ~ 0.1;
#0000FF -> #00FF00;
#FF0000 -> #00FF00 ~ 0.1;

#FF0000; 
#00FF00; 
#0000FF;

#FF0000 ~ 0.02; 
#00FF00 ~ 0.02; 
#0000FF ~ 0.02;

#FF0000 -> #00FF00 ~ 0.02;

#FF0000 ~ 0.02; 
#00FF00 ~ 0.02; 
#0000FF ~ 0.02; 
#00000000; // Transparent => removed

{
  "success" : true
}

$ curl "https://api.vectorizer.ai/api/v1/account" \
 -u vkyc67kqa27yidd:[secret]

{
  "subscriptionPlan" : "none",
  "subscriptionState" : "ended",
  "credits" : 0
}

Nhà phát triển Changelog

• Tổng quan về nhà phát triển
• Tài Liệu
• Xuất Các Tùy Chọn/
• Phản Hồi Lỗi