API Genel Bakış

4 dk okuma

API Genel Bakış

GoVista API'si, dijital tabela yönetimini kendi uygulamalarınıza, web sitelerinize ve iş sistemlerinize entegre etmenize olanak tanır.

Temel URL

Tüm API istekleri şu adrese yapılır:

`` https://api.govista.app/v1/ ``

Kimlik Doğrulama

İstekleri Authorization başlığında bir API anahtarı kullanarak doğrulayın:

`` Authorization: Bearer API_ANAHTARINIZ ``

API anahtarlarını Ayarlar > API > API Anahtarları bölümünden oluşturun. Detaylar için API Anahtarları makalesine bakın.

Hız Limitleri

| Anahtar Kapsamı | Hız Limiti | |----------------|------------| | Okuma | 100 istek/dakika | | Yazma | 30 istek/dakika | | Yönetici | 30 istek/dakika |

Hız limiti aşıldığında API, Retry-After başlığıyla HTTP 429 döndürür.

Yanıt Formatı

Tüm yanıtlar JSON kullanır:

``json { "success": true, "data": { ... }, "meta": { "page": 1, "total": 100 } } ``

Hata yanıtları:

``json { "success": false, "error": { "code": "DEVICE_NOT_FOUND", "message": "İstenen cihaz mevcut değil." } } ``

Sayfalama

Liste uç noktaları sayfalamayı destekler:

`` GET /v1/devices?page=1&limit=20 ``

Test ve API'yi keşfetme için Okuma kapsamıyla başlayın. Programatik olarak değişiklik yapmaya hazır olduğunuzda Yazma veya Yönetici kapsamına yükseltin.

Mevcut Uç Noktalar

  • Cihazlar/v1/devices — Cihazları listele, oluştur, güncelle, sil
  • İçerik/v1/content — Medya varlıklarını yükle, listele, yönet
  • Playlistler/v1/playlists — Playlistler üzerinde CRUD işlemleri
  • Zamanlamalar/v1/schedules — Zamanlamaları oluştur ve yönet
  • Mağazalar/v1/stores — Fiziksel konumları yönet
  • Analitik/v1/analytics — Performans verilerini sorgula
  • Komutlar/v1/commands — Uzaktan komut gönder

SDK'lar ve Kütüphaneler

GoVista resmi API istemci kütüphaneleri sağlar:

  • JavaScript/TypeScript (npm)
  • Python (pip)
  • PHP (Composer)

Webhooklar

Gerçek zamanlı olay bildirimleri alın. Yapılandırma detayları için Webhooklar makalesine bakın.

API sürümlendirilmiştir. URL'lerinize her zaman /v1/ ekleyin. Uyumsuz değişiklikler eski sürümler için kullanım dışı kalma bildirimleriyle yeni sürümlerde (v2, v3) sunulacaktır.

Bu makale yardımcı oldu mu?