Kimlik Doğrulama ve API Anahtarları

Sayfayı kopyala

Shopify Flow için Workflow Transactional Email REST API ve MCP sunucusu API anahtarı oluşturun; okuma, yazma ve çalıştırma erişim düzeylerini seçin.

Hem REST API hem de MCP sunucusu aynı kimlik bilgilerini kullanır: Uygulama içindeki Geliştirici sayfasında oluşturulan bir API anahtarı.

Ana URL

Tüm talepler şu adrese gönderilir:

text

https://shopify.workflow-transactional-email.app

Aşağıdaki tüm uç noktalar söz konusu ana bilgisayara göredir; dolayısıyla dizinin tam yolu https://shopify.workflow-transactional-email.app/api/v1 şeklindedir.

Anahtar oluşturma

Uygulamada Geliştirici bölümünü açın, bir erişim düzeyi seçin ve anahtarı oluşturun. Anahtarın tam değeri,** oluşturulduğu anda tek seferlik olarak** gösterilir. Bu değeri kopyalayın ve şifre yöneticinize veya gizli veriler deponuzda saklayın; daha sonra bu değer geri alınamaz, çünkü sadece SHA-256 hash değeri saklanır.

Anahtarlar her zaman fak_ ile başlar; bu da gizli bilgi tarayıcısında kolayca tespit edilmelerini sağlar.

Hamiline token olarak gönderin:

vbnet

GET /api/v1/me HTTP/1.1
Host: shopify.workflow-transactional-email.app
Authorization: Bearer fak_your_key_here

GET /api/v1/me, bir anahtarın çalışıp çalışmadığını doğrulamanın ve hangi seviyeye sahip olduğunu görmenin en hızlı yoludur.

Erişim düzeyleri

Seviyeler sıralı ve birikimlidir: her seviye, kendisinden önceki tüm seviyeleri içerir.

Seviye	Ne gibi bir katkı sağlıyor?
Yalnızca okunur	E-posta düzenlerini, e-posta gönderenlerini, gizli adları, yüklenen dosyaları, HTTP isteklerini, geçmişi ve istatistikleri okuyun
Okuma ve yazma	HTTP isteklerini oluşturun, düzenleyin ve silin; ayrıca kullanılmayan yüklü dosyaları silin
Oku, yaz ve çalıştır	HTTP isteğini gerçek hedefe yöneltin

Üstteki iki seviyenin ne kadar dar olduğuna dikkat edin. E-posta ile ilgili her şey okunabilir durumdadır ve hiçbir seviyede yazma izni yoktur - aşağıya bakınız.

Bir yazma anahtarının neleri değiştirebileceği ve neleri değiştiremeyeceği

Şunları yapabilir: HTTP istekleri oluşturabilir, düzenleyebilir, silebilir ve çalıştırabilir; ayrıca hiçbir şeyin referans vermediği yüklü dosyaları silebilir.

Yapılamaz: Müşterilerinizin ne alacağını belirleyen hiçbir şeye müdahale edemezsiniz. E-posta şablonları, e-posta gönderenleri ve gizli bilgiler için hiçbir erişim düzeyinde yazma uç noktası bulunmaz ve “send-email” uç noktası da hiç yoktur. E-posta, Shopify Flow iş akışınız Send Transactional Email eylemini çalıştırdığında gönderilir; API ise bunu yalnızca sonradan kaydeder ve raporlar.

Herhangi bir düzen veya ön ayar dosyayı hâlâ kullanıyorken dosya silme işlemi de reddedilir; bu sayede bir yazma tuşu, logosunu kaldırarak aktif bir e-postayı bozamaz.

Bir düzeni değiştirmeniz veya bir göndereni bağlamanız gerekiyorsa, bunu uygulama üzerinden yapın.

Neden “execute” ayrı bir komut?

Bir HTTP isteği çalıştırmak, gerçek bir üçüncü taraf sistemine gerçek bir istek gönderir. Bunu kendi düzeyinde tutmak, yapılandırmayı okumak ve düzenlemek için bir komut dosyasına - veya bir yapay zeka asistanına - verdiğiniz anahtarın, canlı entegrasyonlarınıza istek gönderememesi anlamına gelir.

Varsayılan olarak okuma izinleri verin. Yalnızca belirli bir iş için gerekli olduğunda yazma veya çalıştırma izinleri ekleyin.

Bir anahtarın iptal edilmesi

Geliştirici sayfasındaki anahtarı silin. İptal işlemi bir sonraki istekle birlikte yürürlüğe girer; beklemeniz gereken bir önbellek yoktur.

Bir anahtar bir depoya kaydedilmişse, paylaşılan bir belgeye yapıştırılmışsa veya artık buna ihtiyaç duymayan bir yükleniciye verilmişse, anahtarı iptal edin ve yeniden oluşturun.

İyi alışkanlıklar

HTTP isteklerinizde kimlik bilgilerini başlığa veya gövdeye yapıştırmak yerine {{ secrets.KEY }} şeklinde referans olarak belirtin. API yanıtlarında kimlik bilgilerinin tam metinleri maskelenir, ancak bir gizli anahtara referans vermek daha iyidir.
Her bir tüketici için ayrı bir anahtar kullanın; böylece diğer entegrasyonları etkilemeden tek bir entegrasyonu iptal edebilirsiniz.
Yazılımcıların dizüstü bilgisayarlarında ve yapay zeka asistanı yapılandırmalarında yürütme anahtarlarını devre dışı bırakın; tabii asistanın gerçek zamanlı istekler gönderebilmesini özellikle istemiyorsanız.