İçeriğe geç
Bu sayfada

Entegrasyonlar

API anahtarları ve SDK ile kendi arayüzünüzü geliştirme

Geliştirici bölümünde yayınlanabilir ve gizli site anahtarı oluşturun, @teachfluence/sdk ile katalog, sepet ve ödeme akışını kurun, sitenizi @teachfluence/cli ile yayına alın.

Kendi sitenizi yazıp Teachfluence verinizle çalıştırabilirsiniz. Katalog, sepet ve ödeme akışı @teachfluence/sdk üzerinden gelir, siteyi @teachfluence/cli ile yayına alırsınız. Bu sayfa anahtar oluşturmayı, SDK'nın temel akışını ve dağıtımı anlatır. Sitenizi kuran geliştirici içindir.

1. Site anahtarı oluşturun

Geliştirici bölümünü açın

Sol menüden Ayarlar'a gidin. Sayfanın üstündeki Entegrasyonlar ve Bildirimler menüsünü açın ve Entegrasyonlar başlığı altındaki Geliştirici'yi seçin.

Anahtar oluştur'a tıklayın

Bölümün en üstünde Site anahtarları (API) kartı bulunur. Tabloda her anahtarın adı, ilk karakterleri, türü, ne zaman oluşturulduğu, en son ne zaman kullanıldığı ve durumu (Etkin ya da İptal edildi) yer alır. Henüz anahtarınız yoksa tablo yerine Henüz site anahtarı yok. yazar. Listenin sağ üstündeki Anahtar oluştur'a tıklayın.

Planınız Scale'in altındaysa düğmede kilit simgesi görünür. Tıkladığınızda hangi planın gerektiğini görürsünüz.

Adı ve türü seçin

Site anahtarı oluştur penceresinde anahtara bir Ad verin, örneğin Üretim storefront. Ad en fazla 100 karakter olabilir. Tür alanında birini seçin ve Oluştur'a tıklayın.

TürÖn ekNerede kullanılır
Yayınlanabilirtf_pk_İstemci paketinize koyabilirsiniz. Ziyaretçinin zaten yapabileceğinden fazlasına izin vermez.
Gizlitf_sk_Yalnızca sunucu tarafı. Hesabınızın tamamında okuma yetkisi verir ve site dağıtımı yapabilir, yani sitenizin yayınını değiştirebilir.

Anahtarı kopyalayın

Anahtarınız hazır penceresinde anahtarı kopyalayın ve Tamam'a tıklayın. Pencere, pencerenin dışına tıklayınca ya da Esc tuşuyla kapanmaz.

Kullanılmayan anahtarı iptal edin

Anahtarın satırında İptal et'e tıklayın ve Anahtarı iptal et ile onaylayın. İptal hemen geçerli olur ve geri alınamaz. O anahtarı kullanan siteler ve betikler erişimini kaybeder. İptal edilen anahtar tabloda İptal edildi durumuyla kalır.

2. SDK'yı kurun

npm install @teachfluence/sdk
import { TeachfluenceClient } from '@teachfluence/sdk';

const client = new TeachfluenceClient({
  organizationSlug: 'kurumunuz',
  apiKey: process.env.TEACHFLUENCE_PUBLISHABLE_KEY,
});

organizationSlug zorunludur ve açıkça verilir, çünkü derleme betiğiniz hiçbir alan adı üzerinde çalışmıyor olabilir. apiKey alanına yalnızca yayınlanabilir anahtarı koyun. SDK tarayıcıda bir tf_sk_ anahtarı görürse hata verir.

Tarayıcıda SDK yalnızca kurumunuzun kendi adreslerindeki sayfalardan çalışır: Teachfluence alt alan adınız ve doğrulanmış özel alan adınız. localhost ya da başka bir alan adındaki bir sayfanın isteğini tarayıcı reddeder. Oradan API'yi kendi sunucunuz üzerinden çağırın.

Kataloğu okumak:

const { organization } = await client.catalog.list({ first: 20 });
const { course } = await client.catalog.course({ slug: 'react-101' });

client.catalog.list kursları, paketleri, dijital ürünleri ve canlı etkinlikleri tek istekte getirir. client.catalog ayrıca digitalProduct, liveEvent, coachingSession, subscriptionProducts ve contentBlog (blog ve yardım sayfalarınız) işlevlerini taşır.

3. Sepet ve ödeme

Satın alınan şey kursun dönemidir. Fiyat, kontenjan ve satın alınabilirlik dönemde tanımlıdır. Sepete dönemin kimliğini eklersiniz.

const term = course?.academicTerms[0];

if (term?.viewerCanOrder) {
  const { addCartOrderable } = await client.cart.add({
    cartId: localStorage.getItem('cartId'),
    orderableId: term.id,
  });

  localStorage.setItem('cartId', addCartOrderable.cart.id);
}

Sepet, giriş yapmamış ziyaretçi için de çalışır. Dönen sepet kimliğini saklayın. Saklamazsanız her istek yeni bir sepet açar.

Siparişi oluşturup alıcıyı ödeme sayfasına gönderin:

const { createOrder } = await client.checkout.createOrder({ cartId });

window.location.href = client.checkout.paymentUrl(createOrder.order.slug);

Alıcının hesap açması gerekmez. Ödeme Teachfluence'ın barındırdığı sayfada tamamlanır. Kart bilgisi sizin kodunuzdan geçmez, fatura ve vergi kuralları Teachfluence'ta kalır.

Oturum açma için client.session, öğrencinin kendi kayıtlarını, siparişlerini ve sertifikalarını okumak için client.me kullanılır. Bir iş kuralı isteği reddettiğinde (süresi dolmuş kupon, dolu kontenjan) SDK TeachfluenceUserError fırlatır. Bu hatayı isUserError ile ayırıp forField ile ilgili form alanına yazarsınız.

4. Sitenizi yayına alın

Siteyi kendi bilgisayarınızda ya da CI ortamınızda derleyin, sonra gizli anahtarla dağıtın:

export TEACHFLUENCE_SECRET_KEY=tf_sk_...
npx @teachfluence/cli deploy ./dist --org kurumunuz --route /egitimler

CLI gizli anahtarı TEACHFLUENCE_SECRET_KEY ortam değişkeninden okur. Bayrak olarak yazılsaydı kabuk geçmişinize ve süreç listesine düşerdi. Yayınlanabilir anahtarla dağıtım yapılamaz.

BayrakNe yapar
--org <slug>Hangi organizasyona dağıtılacağı. Zorunlu.
--route <yol>Sitenin sunulacağı yol. Vermezseniz paket yüklenir ama hiçbir trafiğe yanıt vermez.
--sectionKök adres için derlenmiş bir sitenin yalnızca bir bölümünü --route ile verdiğiniz yolda sunar.
--site--route / ile birlikte sitenizin tamamını kök adresten sunar. --take-over-site ister.
--take-over-siteKök adresin tamamını almayı onaylar. --force'tan ayrıdır.
--forceMevcut sayfalarınızı gizleyecek bir yolu yine de yayınlar.
--label <sha>Dağıtımı bir kaynak sürümüyle etiketler. İsteğe bağlı.
--allow-project-rootProje kökü gibi görünen bir klasörü yine de yükler.

Tanınmayan bir bayrak yok sayılmaz, komut hata verir. Mevcut sayfalarınızı gizleyecek bir yol isterseniz işlem reddedilir ve nelerin gizleneceği listelenir. Bilerek yapıyorsanız --force ekleyin.

Yüklediğiniz sürümleri ve yayındaki adresleri Web Sitesi › Web Sayfalarım › Kod ile Yayın ekranında görürsünüz. Bir sürümü geri almak da oradan yapılır: Kod ile yayına alma.

Kök adrese dağıtım

--route / iki farklı kapsamda kabul edilir:

  • Yalnızca --route / verirseniz site tek bir adresi alır. index.html dosyanız / adresinde sunulur, /assets/app.js gibi diğer her adres platforma düşer. Tek sayfalık bir site için yeterlidir.
  • --site --take-over-site eklerseniz siteniz kökten bütün olarak yayınlanır. Platformun kendi adresleri dışındaki her adres (/hakkimizda, /blog/merhaba dahil) sizin dosyanıza gider. Ödeme ve giriş sayfaları platformda kalır.
npx @teachfluence/cli deploy ./dist --org kurumunuz --route / --site --take-over-site

Kök adresten yayınlanan siteyi taban yolu vermeden derleyin.

Kök adresten bütün olarak yayınlanan bir sitede şunları da planlayın:

  • Her adres paketteki <yol>/index.html dosyasına karşılık gelir. Tek bir index.html ile istemci tarafında yönlendirme yapan bir uygulama, / dışındaki her adreste 404 verir.
  • Eşleşmeyen adresler boş bir 404 sayfası döner. Paketinizdeki 404.html kullanılmaz.
  • /favicon.ico paketten sunulmaz. Simgenize HTML'inizden başka bir yolla bağlantı verin.

5. Katalog sayfalarını derlerken oluşturun

Verisini tarayıcıda çeken bir site, derleme sırasında önceden oluşturulmazsa arama motorlarına boş görünür. Teachfluence'ın sayfa oluşturucusu bu işi kendisi yapar. Kendi arayüzünüzde bu iş sizdedir, bu yüzden katalog sayfalarınızı derleme zamanında oluşturun.

Sınırlar

  • Ödeme formu sizin sitenizde çalışmaz. Alıcıyı satın alma düğmesine kadar getirirsiniz, ödemeyi Teachfluence'ın barındırdığı sayfa tamamlar.
  • SDK yalnızca Teachfluence'ın yayınladığı işlemleri çağırır, serbest sorgu gönderilemez.
  • Sınav işlemleri SDK'da şu anda yok. Öğrenciyi sınav için platformun kendi sınav sayfasına gönderin.
  • Ödev dosyaları SDK'dan okunur ama yüklenemez. Dosya yüklemeli ödevler için öğrenciyi platformun kendi ödev sayfasına gönderin.

İlgili