Doğru API sürümünü seçin

Güncel uygulama /app/api/v1 API’sini kullanır. Eski entegrasyonlar ayrı api.screenapp.io/v2 hizmetini kullanabilir. Uç noktaları, kimlik bilgileri ve yükleme akışları birbirinin yerine kullanılamaz.

Mevcut bir entegrasyonu değiştirmeden önce temel URL’sini ve hesap neslini belirleyin. Eski bir entegrasyon için v2 referansına bakın ve geçiş desteğini ScreenApp ile teyit edin.

Güncel uygulamada anahtar oluşturun

Güncel uygulamada Settings > API bölümünü açın. Gereken en dar izinlerle adlandırılmış bir anahtar oluşturun ve gösterildiğinde kaydedin. Anahtarı gizli tutun, açığa çıkarsa iptal edin. Anahtarın kişisel mi yoksa ekip bağlamında mı olduğunu kontrol edin.

Güncel genel izinler: files:read and files:upload.

Hesap bağlamınızı okuyun

SCREENAPP_API_KEY değerini ortam değişkenlerinizde gizli olarak tanımlayın. Anahtarı istemci tarafı HTML’e koymayın ve bir depoya commit etmeyin.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Dosya yükleyin

Yükleme iznine sahip bir anahtar kullanın. Yerel dosya adını kendi dosyanızla değiştirin.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "file=@recording.mp4"

Yanıt yeni dosyanın kimliğini içerir. İşleme arka planda devam eder. transcriptStatus değeri ready olana kadar GET /app/api/v1/videos/{id} isteğini tekrarlayın, ardından GET /app/api/v1/videos/{id}/transcript isteyin.

Güncel doğrudan API yüklemelerinde istek gövdesi sınırı 512 MB. Bu yalnızca bir API sınırıdır; uygulamadaki yüklemelerde belirli bir dosya boyutu sınırı yoktur. Aynı videos uç noktası, yerel dosya yüklemek yerine herkese açık bir url içeren JSON nesnesi de kabul eder.

Kayıtları okuyun

GET /app/api/v1/videos anahtarın alanındaki kayıtları listeler.
GET /app/api/v1/videos/{id} durum ve meta verileri döndürür.
GET /app/api/v1/videos/{id}/transcript hazır olduğunda transkripti döndürür.

Bu istekler için okuma izni kullanın. Eksik veya geçersiz anahtar 401, yetersiz izin 403, hız sınırı 429 döndürür. Retry-After gönderilirse ona uyun. Hazır olmadan istenen bir transkript 409 döndürebilir.

Kaydediciyi yerleştirin

Yerleştirmenin ayrı bir kurulumu ve alan adı kısıtlaması vardır. Kaydedici yerleştirme adımlarını izleyin. Özel REST anahtarını yerleştirme belirteci olarak kullanmayın.

Bu örnekler güncel API sözleşmesini açıklar. Çalışan eski bir entegrasyonu değiştirmeden önce bunları kullanacağınız hesapta ve ortamda doğrulayın.