Görüntü Vektörleştirme Geliştirici Belgeleri

Vectorizer.AI resmi SDK'lar, komut satırı istemcisi, OpenAPI özellikleri ve tam teşekküllü bir bitmap izleme API'si sunar. Bu geliştirici araçlarının tümü, pikselleri vektörlere tam otomatik olarak ve sınıfının en iyisi doğrulukla izlemek için aynı hizmeti kullanır.

Doğrudan API Hızlı Başlangıç

Doğrudan HTTP entegrasyonları için, bir bitmap görüntüsü POST yapın ve vektörleştirilmiş bir sonucu geri alın:

• File
• URL

$ curl https://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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://tr.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

Geliştirici Chatbot

SDK'lar, komut satırı, OpenAPI ve doğrudan HTTP API arasındaki Vectorizer.AI geliştirici entegrasyonlarına yardımcı olabilecek özel bir ChatGPT oluşturduk. Bu dokümanlarla ilgili soruları yanıtlayabilir ve kullanım durumunuza göre uyarlanmış tercih ettiğiniz dilde örnek kod veya komutlar sağlayabilir.

Sohbet robotu şu an beta seviyesinde ve hata yapabilir. Verdiği cevapları kontrol edin ve hataları ve eksiklikleri düzeltmek için kodu gözden geçirmesini isteyin.

SDK'lar

Resmi SDK'ler genel OpenAPI spesifikasyonundan oluşturulur ve doğrudan API çağrılarıyla aynı HTTP Temel kimlik doğrulamasını kullanır. Çoğu uygulama entegrasyonu için önerilen başlangıç noktasıdır ve hesap ve silme çağrıları JSON modellerini döndürürken vektörleştirme ve indirme çağrıları dosya içeriğini döndürür.

Tüm SDK'lar https://api.vectorizer.ai/api/v1 'yi hedefler ve kararlı /vectorize, /download, /delete ve /account uç noktalarının etrafındaki sarıcılardır.

Uygulama entegrasyonları için SDK'ları tercih edin. Özel jeneratörler, desteklenmeyen diller veya doğrudan protokol çalışması için OpenAPI spesifikasyonunu kullanın. Jeneratör yapılandırması GitHub 'da mevcuttur.

İstemci araçları bildirimini indirin

Komut satırı

Resmi komut satırı istemcisi, Windows, macOS ve Linux için bağımsız bir yürütülebilir dosyadır. Kabuklar, komut dosyaları, toplu işleme, QA iş akışları ve uygulama kodu yazmadan görüntüleri vektörleştirmek isteyen kullanıcılar için tasarlanmıştır.

Mevcut sürüm için aşağıdaki doğrudan indirme bağlantılarını kullanın. Tüm sürüm dosyaları ve kontrol toplamları GitHub Releases'da da mevcuttur veya kaynağı GitHub'da görüntüleyebilirsiniz. CLI, doğrudan API çağrıları ve SDK entegrasyonları ile aynı API kimlik bilgilerini, sunucu ve uç nokta davranışını kullanır.

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

Bir uygulamaya Vectorizer.AI eklerken SDK 'ları kullanın ve doğal arabirim terminal, zamanlanmış iş veya dosya işleme boru hattı olduğunda komut satırı istemcisini kullanın.

OpenAPI Spesifikasyonu

Doğrudan API, oluşturulan istemciler, şema doğrulaması ve API keşfi için bir OpenAPI 3.0 spesifikasyonu olarak mevcuttur. Aynı özellik, resmi SDK oluşturma iş akışını da yönlendirir.

Spesifikasyon https://api.vectorizer.ai/api/v1 'i sunucusu olarak bildirir, bu nedenle oluşturulan istemciler /vectorize, /download, /delete ve /account gibi uç nokta yollarını kullanır.

Entegrasyon İş Akışları

Bu iş akışları, resmi bir SDK, komut satırı istemcisi veya doğrudan HTTP API kullanıyor olun geçerlidir. Yaygın olan bir kaç tanesi şunlardır:

Tek Resim Biteşlem ekle, vektör sonucu al, işlem tamam

Vectorize iş akışını doğrudan bir SDK aracılığıyla veya komut satırı istemcisiyle arayın.

Önce Önizleme Yap Satın alma işlemi yapmadan önce olası müşterinize önizlemeyi gösterin

Satış yapmak için çok sayıda servis çağrısı yapmanız gerekiyorsa, bir müşteriyi gerçekten dönüştürene kadar daha düşük maliyetli önizlemeleri kullanabilirsiniz.

1. Önizlemeyi almak için bir SDK, komut satırı istemcisi aracılığıyla Vectoriz e'i çağırın veya mode=preview ve policy.retention_days > 0 ile doğrudan HTTP öğesini çağırın ve X-Image-Token yanıt başlığında döndürülen Görüntü Belirtecini koruduğunuzdan emin olun.

2. Dönüştürdükten sonra, tam sonucu indirmek için Görüntü Belirteci ile İndir'i arayın.

3. İsteğe bağlı: ek sonuç formatlarına (örneğin PNG, PDF, vb.) ihtiyaç duyduğunuz takdirde, X-Receipt indirme yanıt başlığında döndürülen Alındıyı sakladığınızdan emin olun. Ardından, kalan formatları indirmek için Görüntü Belirteci ve Makbuz ile İndirme iş akışını kullanın.

Çoklu-Format Örneğin, hem PNG hem de SVG sonuçlarına ihtiyacınız var

1. İlk sonucu almak için policy.retention_days > 0 ile Vectorize öğesini çağırın ve X-Image-Token yanıt başlığında döndürülen Görüntü Belirtecini koruduğunuzdan emin olun.

2. Diğer formatları indirmek için Image Token ile İndir'i arayın.

Çoklu-Seçenek Her resmi çoklu işleme seçenekleriyle işlemeniz gerekiyor

1. İlk sonucu almak için policy.retention_days > 0 ile Vectorize öğesini çağırın ve X-Image-Token yanıt başlığında döndürülen Görüntü Belirtecini koruduğunuzdan emin olun.

2. İhtiy acınız olan kalan işleme seçeneklerini yinelemek için Görüntü Belirteci ile Vektörleştir'i çağırın.

Ya da alternatif olarak her bir resmi ayrı ayrı işleyebilir ve Resim Belirtecini görmezden gelebilirsiniz. Resim Belirteci size biraz bant genişliği ve gecikmesi süresinden tasarruf sağlar.

Fiyatlandırma

Abonelik planları için lütfen fiyatlandırma sayfasına bakınız.

Kimlik Doğrulaması ve Güvenlik

API standart HTTP temel erişim kimlik doğrulaması kullanmaktadır. API'ye yapılan tüm isteklerin HTTPS üzerinden yapılması ve sizin kullanıcı olarak API kimliğinizi ve şifre olarak da API Parolası ile API Bilgilerinizi içermesi gerekmektedir.

Resmi SDK'lar ve komut satırı istemcisi aynı kimlik bilgilerini kullanır ve sizin için HTTP Basic kimlik doğrulama başlığını ekler.

Http istemci kitaplığınızın istekleri başarıyla gerçekleştirmesi için Sunucu Adı Belirtme (SNI) desteklemesi gerekmektedir. Eğer garip el sıkışma hatalarıyla karşılaşıyorsanız nedeni muhtemelen budur.

Hız Sınırı

API kullanım limitleri gayet bol tutulmuştur ve kesin bir üst sınır bulunmamaktadır.

Normal son kullanıcı işlemlerinde herhangi bir hız sınırlamasına rastlamanız pek olası değildir. Zira o durumdaki kullanım inişli çıkışlı olma eğilimindedir ve servis de bunun altından gayet rahatlıkla kalkar.

Bununla birlikte, gruplu işlerde en fazla 5 iş parçacığı ile başlayıp, arzu edilen paralelliğe erişene kadar her 5 dakikada bir yeni iş parçacığı eklemenizi tavsiye ediyoruz. Eğer 100'den fazla eş zamanlı iş parçacığına ihtiyacınız olacaksa çalışmaya başlamadan önce lütfen bizimle iletişime geçin.

Paralellikte bu kademeli artışı elde etmenib en kolay yolu kullanmayı planladığınız iş parçacığı sayısı kadar iş parçacığını hemen başlatıp, daha sonra ise 5 izinle başlayan bir sayım yapan sefamor kullanmaktır. Daha sonra ise her 5 dakikada bir izinlerin sayısını artıran, ayrı bir iş parçacığı kullanabilirsiniz.

Eğer çok fazla istek girişi yaparsanız, 429 Too Many Requests yanıtları almaya başlarsınız. Bu olduğunda doğrusal geri çekilme uygulamalısınız: böyle bir yanıtı ilk aldığınızda, bir sonraki isteği girmeden önce 5 saniye bekleyin. İkinci ardışık 429 yanıtında, bir sonraki isteği girene kadar 2*5=10 saniye bekleyin. Üçüncüde 3*5=15 saniye bekleyin.

İsteğinizin başarılı olmasının ardından geri çekilme sayacını sıfırlayabilirsiniz. Geri çekilmeyi iş parçacığı başına olacak şekilde uygulamanız iyi olacaktır (Mesela iş parçacıkları birbirinden bağımsız olarak çalışmalıdır).

Zaman aşımları

API talepleri normalde saniyeler içerisinde tamamlanmakla birlikte ani geçici yük artışları esnasında daha uzun süren işlem süreleriyle karşılaşılması olasıdır.

İstemci kitaplığınızın API isteklerini erkenden sonlandırmadığından emin olmak için eylemsiz zaman aşımının en az 180 saniye olarak ayarlanması gerekmektedir.

Resmi komut satırı istemcisi varsayılan olarak daha uzun bir zaman aşımına sahiptir, ancak özel SDK ve doğrudan HTTP entegrasyonları yine de açıkça uygun bir zaman aşımı ayarlamalıdır.

Hatalı JSON

API isteğinin başarılı veya başarısız olduğunu göstermek için geleneksel HTTP statüleri kullanılır ve hataya ilişkin önemli bilgiler dönen Hatalı JSON Nesnesinde bulunur.

Herhangi bir sorunlu istek olması durumunda Hatalı JSON Nesnesi yollamaya çalışıyoruz. Ancak teorik olarak JSON-dışı hata yanıtına neden olan dahili sunucu hatalarının olması her zaman mümkündür.

Eğer isteğinizin HTTP statüsü 200 ise hiçbir hatalı JSON Nesnesi döndürülmeyecektir. İsteğin genel anlamda başarılı olduğunu düşünebilirsiniz.

Bazı HTTP İstemci kitaplıkları 400-599 aralığındaki HTTP statüleri için özel durum oluşturmaktadır. Bu özel durumları yakalayıp uygun bir şekilde işlem yapmanız gerekecektir.

SDK'lar bu başarılı olmayan yanıtları yerel istisnalar veya hata değerleri olarak gösterirken, komut satırı istemcisi API hata ayrıntılarını standart hataya yazdırır.

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

Hata ayıklama yapabilmeniz için Son zamanlardaki API hataları hesabınız sayfasında listelenmiştir.

Ayrıca API tarafından döndürülen tüm hata yanıtlarının bir listesi de bulunmaktadır.

Yanıt Başlıkları

Kullandığımız özel yanıt başlıkları şöyle:

Bir SDK kullanırken, Görüntü Belirteçlerine, Makbuzlara, kredi bilgilerine veya yeniden deneme başlıklarına ihtiyacınız varsa başlığa duyarlı yöntem varyantını kullanın. Komut satırı istemcisini kullanırken, Görüntü Belirteçleri ve Makbuzlar standart hataya yazdırılır, böylece ikili çıktı hala standart çıktıya yazılabilir.

#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
}

Geliştirici Changelog

• Geliştiriciye Genel Bakış
• Belgeler
• Çıktı Seçenekleri
• Hata Yanıtları