Was ist eine API-Schnittstelle in Skava?

Ein Formular, dessen ausgefüllte Werte Skava als JSON an eine von dir hinterlegte https://-Adresse (dein Backend) sendet — praktisch, um Skava mit eigenen Systemen zu verbinden.

Wer darf API-Schnittstellen anlegen und auslösen?

Anlegen und Bearbeiten ist Firmen-Admins vorbehalten. Eine freigegebene Schnittstelle können anschließend alle Mitglieder der Firma auslösen.

Was ist der Unterschied zwischen „Ping“ und „Test-Request“?

Ping prüft nur, ob die Adresse erreichbar ist — ohne Token und ohne Daten. Test-Request sendet Beispieldaten inklusive Token und zeigt die vollständige Antwort.

Ist mein API-Token sicher?

Ja. Der Token wird verschlüsselt gespeichert und nie an Clients ausgeliefert. Die App zeigt nur, ob ein Token gesetzt ist und wann er abläuft.

Welche Adressen sind als Endpunkt erlaubt?

Nur öffentlich erreichbare https://-Adressen. Interne Ziele wie localhost, private Netze oder Cloud-Metadaten werden abgelehnt — das schützt vor Missbrauch der Schnittstelle.

Warum kann ich eine freigegebene Schnittstelle nicht mehr ändern?

Freigegebene Schnittstellen sind bewusst unveränderlich — so kann nach der Freigabe niemand mehr Zieladresse oder Token austauschen. Für Änderungen legst du eine neue Version an.

Özel Öğeler: API

API arayüzü, doldurulmuş değerlerini Skava'nın belirttiğiniz bir adrese (kendi back-end'iniz) JSON olarak gönderdiği bir formdur. Bu şekilde Skava'yı güvenli bir şekilde kendi sistemlerinizle bağlayabilirsiniz.

Web Uygulaması'nda Özel Öğeler → API Arayüzleri geçişini kullanarak API arayüzlerini yönetirsiniz. Oluşturma ve düzenleme şirket yöneticileri ile sınırlıdır; yayınlanan arayüzler daha sonra şirketin tüm üyeleri tarafından kullanılabilir.

API arayüzü kurun

Arayüz giriş alanlarından (JSON oluştururlar), hedef adresinden ve kimlik doğrulamadan oluşur.

Alanlar oluşturun: Her alan bir JSON anahtarı alır. Sağda canlı JSON ön izlemesi görsünüz, back-end'inize tam olarak bu şekilde gönderilir.
Adres (URL): back-end'inizin https:// adresi. Sadece HTTPS ve genel olarak erişilebilir adresler izin verilir (Güvenlik altında görmek için).
Yöntem: POST (varsayılan), PUT, PATCH veya GET. GET ile değerler sorgu parametreleri olarak eklenir, gövdede gönderilmez.
Kimlik Doğrulama: Başlık adını (ör. Authorization) ve değer önekini (ör. Bearer ) ayarlayın, ardından token kaydedin. İsteğe bağlı olarak son kullanma tarihi ayarlayın.
Yanıt alanları (isteğe bağlı): Yol ile tanımlayın, back-end yanıtından hangi değerlerin görüntülenecek — ör. order.id veya items[0].sku.
Ping ve Test İsteği ile kontrol edin, ardından Yayımla.

Token'i güvenli olarak depola

Token şifrelenmiş olarak depolanır ve hiçbir zaman istemcilere döndürülmez — uygulama yalnızca bir token ayarlanmış mı ve ne zaman sona erecek gösterir. Gönderirken, Skava sunucu tarafında bunu yapılandırılmış başlığa ekler. Son kullanma tarihi ayarlarsanız, Skava son kullanma tarihinden sonra çağrıyı reddeder ve token'i yenilemenizi ister.

Test: Ping ve Test İsteği

Ping — hafif bir ulaşılabilirlik kontrolü. Sadece adresinizin yanıt verip vermediğini kontrol eder ve işlemde token veya form verisi gönderme yapmaz. Ulaşılabilirlik, durum ve yanıt zamanını gösterir. Başlangıç olarak ideal.
Test İsteği — gerçek deneme çalışması: token içeren örnek veri adresinize gönderir ve size tam yanıtı ve çıkarılan yanıt alanlarını gösterir.

Yönetici olarak, yayımlamadan önce tümleşimi doğrulamak için taslak modda iken her ikisini de çalıştırabilirsiniz.

Taslak ve Yayın

Her arayüz taslak olarak başlar ve serbestçe düzenlenebilir. Her şey hazır olduğunda, Yayımla ile yayımlanız.

Yayınlanan arayüzler değişmezdir. Bu kasıtlıdır: yayımlandıktan sonra kimse hedef adresi veya token'i gizlice değiştiremez. Bir şey değiştirmek istiyorsanız, yeni bir sürüm oluşturun.

Güvenlik

Arayüzün suistimal edilmesini önlemek için, katı kurallar uygulanır: sadece HTTPS adresleri izin verilir ve adres herkese açık bir hedef adresine işaret etmelidir — dahili adresler (ör. localhost, özel ağlar veya bulut meta verileri) reddedilir. Skava her çağrı sırasında bunu kontrol eder, doğru adrese tam olarak bağlanır, yeniden yönlendirmeleri takip etmez ve zaman aşımı ve yanıt boyutunu sınırlar.

İlişkili

Bunun yerine doldurulabilir belge şablonu oluşturmak istiyor musunuz? Özel Öğeler: Belgeler'e bakın.

Sık Sorulan Sorular

Skava'da API arayüzü nedir?

Doldurulmuş değerleri Skava'nın belirttiğiniz bir adrese (kendi back-end'iniz) JSON olarak gönderdiği bir form — Skava'yı kendi sistemlerinizle bağlamak için elverişlidir.

API arayüzleri oluşturmaya ve tetiklemeye kim izin alabilir?

Oluşturma ve düzenleme şirket yöneticileri ile sınırlıdır. Yayınlanan arayüz daha sonra şirketin tüm üyeleri tarafından kullanılabilir.

"Ping" ve "Test İsteği" arasındaki fark nedir?

Ping sadece adresin ulaşılabilir olup olmadığını kontrol eder — token ve veri olmadan. Test İsteği token içeren örnek veriler gönderir ve tam yanıtı gösterir.

API token'im güvenli mi?

Evet. Token şifrelenmiş olarak depolanır ve hiçbir zaman istemcilere iletilmez. Uygulama yalnızca bir token ayarlanmış mı ve ne zaman sona erecek gösterir.

Uç noktalar olarak hangi adresler izin verilir?

Sadece genel olarak erişilebilir https:// adresler. localhost, özel ağlar veya bulut meta verileri gibi dahili hedefler — arayüzün suistimaline karşı korunur.

Yayınlanan arayüzü neden artık değiştiremiyorum?

Yayınlanan arayüzler kasıtlı olarak değişmezdir — yayımlandıktan sonra kimse hedef adresi veya token'i değiştiremez. Değişiklikler için yeni bir sürüm oluşturun.