TotalApp Dökümanlar

Studio API

Creative Studio işlevselliğini uygulamalarınıza entegre etmek için güçlü API

API Felsefesi

Creative Studio API'si, RESTful mimarisi ve geliştiriciler için tasarlanmış sezgisel yapısıyla uygulamalarınıza güçlü tasarım yetenekleri kazandırır. Her uç nokta tutarlı bir yapı sunar; kimlik doğrulama, hata yönetimi ve yanıt formatları tüm API genelinde standarttır. İster basit bir görsel oluşturma akışı kurarsanız ister karmaşık toplu işleme süreçleri geliştirirseniz, API her senaryoyu destekleyecek şekilde tasarlanmıştır.

Temel API Özellikleri

Görsel Oluşturma API

Metin açıklamalarından veya şablonlardan programatik olarak yüksek kaliteli görseller oluşturun. Toplu oluşturma ve asenkron işleme desteklenir.

Görsel İşleme API

Mevcut görselleri dönüştürün, filtre uygulayın, boyutlandırın ve optimize edin. Tüm görsel düzenleme işlemleri API üzerinden gerçekleştirilebilir.

Fotoğraf Filtresi API

Önceden tanımlanmış veya özel filtre setlerini görsellere uygulayın. Toplu filtre işleme ile büyük görsel koleksiyonlarını verimli şekilde işleyin.

Beyaz Etiket Entegrasyonu

Studio'yu kendi uygulamanıza gömün. Markalı deneyim için özel parametre ve kimlik doğrulama akışlarını kullanın.

API Uç Noktaları

POST /images/generate

Metin açıklaması veya şablon kimliği kullanarak yeni bir görsel oluşturur. Model, boyut ve stil parametrelerini destekler.

POST /images/process

Yüklenen bir görsele filtre, dönüşüm veya düzenleme işlemleri uygular. Zincir işleme için birden fazla işlem geçilebilir.

GET /templates

Mevcut şablon kitaplığını listeler. Kategori, etiket ve arama parametreleriyle filtreleme desteklenir.

POST /export

Oluşturulan içeriği belirtilen formatta (PNG, JPG, SVG, PDF) dışa aktarır. Çözünürlük ve kalite ayarları yapılandırılabilir.

Entegrasyon Yöntemleri

REST API

Standart HTTP yöntemleri ve JSON yanıt formatıyla tüm platformlara entegre olun. Swagger dokümantasyonu mevcuttur.

Webhook'lar

Asenkron işlemler tamamlandığında gerçek zamanlı bildirimler alın. Yeniden deneme mekanizması ve imza doğrulama dahildir.

SDK'lar

JavaScript, Python ve PHP için hazır SDK'larla geliştirme sürenizi kısaltın. Örnek kodlar ve kapsamlı belgeler mevcuttur.

GraphQL

Yalnızca ihtiyacınız olan verileri sorgulayan esnek GraphQL arayüzünü kullanın. Şema introspection desteklenir.

Studio Entegrasyon API

Gömülü Studio Entegrasyonu

Studio'yu iframe olarak uygulamanıza gömün ve aşağıdaki özellikleri programatik olarak kontrol edin:

  • Token tabanlı kimlik doğrulama ile güvenli oturum başlatma
  • Özelleştirme parametreleriyle marka kimliğini ön yükleme
  • Olayları dinleyerek kullanıcı eylemlerine tepki verme
  • JavaScript postMessage API'si üzerinden studio ile çift yönlü iletişim

Görsel Otomasyon API

Toplu İşleme

Binlerce görseli tek bir API çağrısıyla işleyin. Kuyruk yönetimi ve ilerleme takibi dahildir.

Şablon Doldurma

Değişken veri setleriyle şablonları otomatik olarak doldurun. CSV veya JSON verilerinden toplu görsel üretin.

Otomatik Dışa Aktarma

Oluşturulan içerikleri belirlenen bulut depolama alanına veya CDN'e otomatik olarak aktarın.

İş Akışı Entegrasyonu

TotalApp Otomasyon modülüyle entegre olarak tasarım görevlerini iş akışlarınıza dahil edin.

API Kimlik Doğrulama

1. API Anahtarı Al

Ayarlar > API > Yeni Anahtar Oluştur bölümünden API anahtarınızı alın. Her ortam için ayrı anahtar kullanmanızı öneririz.

2. Başlık Yapılandırması

Her istekte Authorization: Bearer YOUR_API_KEY başlığını ekleyin. Anahtar hiçbir zaman istemci tarafında açık bırakılmamalıdır.

3. Token Yenileme

OAuth 2.0 tabanlı oturumlar için token yenileme akışını uygulayın. Refresh token ile yeni erişim tokenı alın.

4. Güvenlik En İyi Uygulamaları

API anahtarlarını ortam değişkenlerinde saklayın. İzin kapsamlarını minimumda tutun ve düzenli olarak rotasyon yapın.

SDK'lar ve Kütüphaneler

JavaScript SDK

Node.js ve tarayıcı ortamları için optimize edilmiş SDK. TypeScript desteği ve tam tip tanımları mevcuttur.

Python SDK

Asenkron destek ve Pydantic model entegrasyonuyla Python uygulamalarına kolay entegrasyon sağlayın.

PHP SDK

Composer ile kurulum yapın. Laravel ve Symfony entegrasyon örnekleri belgelerde mevcuttur.

REST İstemcileri

Postman koleksiyonu ve OpenAPI şeması ile tercih ettiğiniz HTTP istemcisini kullanın.

Kullanım Alanları

E-ticaret

Ürün görsellerini otomatik olarak oluşturun ve boyutlandırın. Farklı platformlar için optimize edilmiş versiyonları toplu üretin.

Sosyal Medya Araçları

Kullanıcıların kendi içeriklerini oluşturabildiği sosyal medya uygulamaları geliştirin.

Pazarlama Platformları

Kampanya görselleri oluşturmayı ve dağıtmayı otomatikleştiren pazarlama araçları entegre edin.

SaaS Uygulamaları

Kendi SaaS ürününüze tasarım yetenekleri ekleyin. Beyaz etiket çözümüyle markalı bir deneyim sunun.

Başlarken

1. API Anahtarı Oluştur

TotalApp panelinden API erişim anahtarınızı oluşturun ve güvenli bir şekilde saklayın.

2. SDK'yı Yükle

Tercih ettiğiniz programlama dili için SDK'yı paket yöneticinizle yükleyin (npm install @totalapp/studio).

3. İlk API Çağrısı Yap

Sandbox ortamında bir test görsel oluşturarak entegrasyonunuzun doğru çalıştığını doğrulayın.

4. Üretime Geç

Testleri tamamladıktan sonra üretim API anahtarınıza geçin ve rate limit kotalarınızı yapılandırın.

Pro İpucu

Üretim ortamına geçmeden önce sandbox ortamında kapsamlı testler yapın. Sandbox, gerçek API ile aynı yapıyı kullanır ancak görsel oluşturma işlemleri kotanıza sayılmaz.

Dikkat

API anahtarlarını kaynak koduna, versiyon kontrol sistemlerine veya istemci tarafı koduna asla dahil etmeyin. Ortam değişkenleri veya güvenli anahtar yönetim hizmetleri kullanın.