TemplioniX (Önizleme)
TemplioniX, yeniden kullanılabilir Word şablonlarından DOCX ve PDF dosyaları oluşturmaya yönelik bir belge oluşturma API'sidir. Şablon meta verilerini ayıklamak, tek bir belge oluşturmak, toplu belge oluşturmayı çalıştırmak, toplu iş durumunu denetlemek, oluşturulan sonuçları indirmek ve abonelik veya kullanım bilgilerini görüntülemek için bu bağlayıcıyı kullanın.
Kimlik doğrulaması, geçirilen bir API anahtarıyla gerçekleştirilir.
Oluşturulan toplu ZIP indirme bağlantıları 24 saat boyunca geçerlidir.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri: - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Contact | |
|---|---|
| İsim | TemplioniX Desteği |
| URL | https://templionix.com |
| E-posta | support@templionix.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | TemplioniX |
| Web Sitesi | https://templionix.com |
| Gizlilik ilkesi | https://templionix.com/privacy-policy |
| Kullanım koşulları | https://templionix.com/terms-of-use |
| Kategoriler | Verimli -lik; İçerik ve Dosyalar |
| IconBrandColor | #333A41 |
TemplioniX Bağlayıcısı
Genel bakış
TemplioniX, yeniden kullanılabilir Microsoft Word şablonlarından ve yapılandırılmış JSON verilerinden DOCX ve PDF dosyaları oluşturmaya yardımcı olan bir belge oluşturma hizmetidir.
Bu bağlayıcı kullanıcıların templioniX API'sine Microsoft Power Automate, Power Apps, Azure Logic Apps ve Copilot Studio iş akışları bağlamasına olanak tanır. Kullanıcılar şablon meta verilerini ayıklayabilir, başlangıç JSON yükleri oluşturabilir, belge oluşturabilir, toplu belge oluşturma işlerini çalıştırabilir, iş durumunu denetleyip oluşturulan sonuçları indirebilir ve kullanılabilir şablonları alabilir.
Publisher
TemplioniX
Hedeflenen Microsoft ürünleri
- Microsoft Power Automate (İş Akışı Otomasyonu)
Bağlayıcı, Microsoft Power Platform özel bağlayıcı olarak uygulanır ve sertifikalı bağlayıcıların desteklendiği diğer Microsoft bağlayıcı deneyimlerinde kullanılabilir.
Kimlik doğrulama
Bağlayıcı API anahtarı kimlik doğrulamasını kullanır. API anahtarı istek üst bilgisinde x-functions-key geçirilir.
Kullanıcıların bu bağlayıcıyı kullanabilmesi için etkin bir TemplioniX hesabına ve geçerli bir API anahtarına sahip olması gerekir.
Ana özellikler
Şablonları alma
TemplioniX'ten kullanılabilir belge şablonlarının sayfalandırılmış listesini alır. Bu işlem meta veriler, başlangıç modeli, tek bir belge veya toplu belge oluşturma işi oluşturmadan önce şablon seçmek için kullanılabilir.
Şablon alanlarını ve yer tutucularını ayıklama
Şablon alanları ve yer tutucular dahil olmak üzere seçili şablondan meta verileri ayıklar. Bu, kullanıcıların şablon tarafından beklenen verileri anlamasına yardımcı olur.
Şablon için başlangıç JSON yükü oluşturma
Seçilen şablona göre örnek bir JSON yükü oluşturur. Kullanıcılar bu yükü, diğer sistemlerden gelen verileri belge oluşturma isteğine eşlemek için başlangıç noktası olarak kullanabilir.
Belge oluşturma
Seçili bir şablondan docx veya PDF belgesi oluşturur ve JSON verilerini ekler.
Belgeleri toplu olarak oluşturma
Seçili bir şablon ve birden çok giriş kaydı kullanarak toplu belge oluşturma işini başlatır. Oluşturulan toplu ZIP indirme bağlantıları 24 saat boyunca geçerlidir.
Toplu oluşturma işi durumunu alma
Belirli bir toplu belge oluşturma işi için durum ve sonuç bilgilerini alır.
Toplu oluşturma işlerini şablona göre alma
Seçili şablonla ilişkili toplu oluşturma işlerini alır.
Yaygın kullanım senaryoları
- Yapılandırılmış verilerden sözleşmeler, faturalar, teklifler, raporlar, mektuplar ve diğer iş belgeleri oluşturun.
- CRM, ERP, formlar, Excel, SharePoint, Dataverse, SQL veya API tabanlı sistemlerden belge oluşturmayı otomatikleştirin.
- bir iş akışından isteğe bağlı olarak tek belgeler oluşturun.
- Toplu olarak birden çok belge oluşturun ve oluşturulan ZIP sonucunu alın.
- Belge oluşturma için hangi alanların gerekli olduğunu anlamak için ayıklanan şablon meta verilerini kullanın.
Örnek iş akışı
- Akışı el ile veya iş olayından tetikleme.
- Şablon seçmek için Şablon al işlemini kullanın.
- Beklenen veri yapısını anlamak için Başlangıç JSON yükü oluşturma işlemini kullanın.
- Kaynak sistem verilerini oluşturulan JSON yapısına eşleyin.
- DocX veya PDF dosyası oluşturmak için Belge oluştur işlemini kullanın.
- Oluşturulan dosyayı OneDrive, SharePoint, Dataverse, e-posta veya başka bir hedefe kaydedin.
Support
Ürün bilgileri, belgeler ve destek için şu adresi ziyaret edin:
- Web sitesi: https://templionix.com
- Dokümantasyon: https://docs.templionix.com
- Destek: https://templionix.com/contact
- Gizlilik ilkesi: https://templionix.com/privacy-policy
- Kullanım koşulları: https://templionix.com/terms-of-use
Sertifikasyon incelemesi için notlar
Bu paket TemplioniX bağlayıcı çözümünü ve bağlayıcı işlemlerini gösteren bir örnek akış çözümü içerir. Bağlayıcı, üretim TemplioniX API'siyle iletişim kurar ve üst bilgi aracılığıyla API anahtarı kimlik doğrulamasını x-functions-key kullanır.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Zorunlu |
|---|---|---|---|
| TemplioniX Api Anahtarı | securestring | Bu api için TemplioniX Api Anahtarı | True |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Kullanılabilir şablonları listeleme |
Meta veri ayıklama, model oluşturma ve belge oluşturma uç noktalarıyla kullanılabilen şablonların sayfalandırılmış listesini döndürür |
| Toplu belge oluşturmayı başlatma |
Paylaşılan bir şablondan belge oluşturmak, okuma SAS URL'si ile zip oluşturmak ve ilerleme durumunu takip etmek için toplu iş başlatın. İş kimliğini hemen döndürür. Döndürülen ZIP indirme URL'si, iş tamamlandıktan sonra kullanılabilir ve oluşturma zamanından itibaren 24 saat geçerlidir. |
| Toplu oluşturma işi durumunu alma |
İşin durumunu kimliğe göre yükler: durum, başlangıç/bitiş saatleri, tamamlandığında ZIP SAS URL'si, başarısız olduğunda düzenleme hatası ve öğe başına ayrıştırma oluşturma hataları. |
| Şablon alanlarını ve yer tutucularını ayıklama |
Seçili şablonu okur ve başlık, etiket, tür ve kullanılabilir olduğunda önceden tanımlanmış değerler de dahil olmak üzere belgede bulunan içerik denetimlerini döndürür. |
| Şablon için başlangıç JSON yükü oluşturma |
Belge oluşturma için giriş olarak yeniden kullanılabilmesi için seçilen şablonda bulunan yer tutucularla eşleşen örnek bir JSON yapısı oluşturur |
| Şablon için toplu oluşturma işlerini listeleme |
TemplateId'nin eşleştiği toplu oluşturma bölümü için tüm işleri döndürür; tek iş durumuyla aynı yük şekli, azalan başlangıç zamanına göre sıralanmış |
| Şablon verilerinden belge oluşturma |
Sağlanan JSON yükünü seçili şablonla birleştirir ve oluşturulan belgeyi döndürür. Word çıktı veya |
Kullanılabilir şablonları listeleme
Meta veri ayıklama, model oluşturma ve belge oluşturma uç noktalarıyla kullanılabilen şablonların sayfalandırılmış listesini döndürür
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa numarası
|
pageNumber | True | integer |
Döndürülecek 1 tabanlı sayfa dizini |
|
Sayfa Boyutu
|
pageSize | True | integer |
Tek bir yanıtta döndürülecek şablon sayısı üst sınırı |
Döndürülenler
Şablon kayıtlarını içeren uzaklık tabanlı sayfalanmış yanıt.
Toplu belge oluşturmayı başlatma
Paylaşılan bir şablondan belge oluşturmak, okuma SAS URL'si ile zip oluşturmak ve ilerleme durumunu takip etmek için toplu iş başlatın. İş kimliğini hemen döndürür. Döndürülen ZIP indirme URL'si, iş tamamlandıktan sonra kullanılabilir ve oluşturma zamanından itibaren 24 saat geçerlidir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Benzersiz şablon tanımlayıcısı |
|
|
Format
|
format | string |
Çıkış biçimi. Word belgeler için .docx veya PDF belgeleri için .pdf kullanma |
|
|
Dosya Adı
|
fileName | string |
Oluşturulan veya istenen dosya adı |
|
|
items
|
items | object |
Döndürülenler
Toplu belge oluşturma işi işlenmek üzere kabul edildiğinde yanıt döndürülür.
Toplu oluşturma işi durumunu alma
İşin durumunu kimliğe göre yükler: durum, başlangıç/bitiş saatleri, tamamlandığında ZIP SAS URL'si, başarısız olduğunda düzenleme hatası ve öğe başına ayrıştırma oluşturma hataları.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Toplu iş tanımlayıcısı
|
jobId | True | string |
generateDocumentsBulk 202 yanıtında döndürülen iş kimliği ( |
Döndürülenler
Toplu belge oluşturma işi için durum ve sonuç ayrıntıları.
Şablon alanlarını ve yer tutucularını ayıklama
Seçili şablonu okur ve başlık, etiket, tür ve kullanılabilir olduğunda önceden tanımlanmış değerler de dahil olmak üzere belgede bulunan içerik denetimlerini döndürür.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon tanımlayıcısı
|
templateId | True | uuid |
Şablon kataloğu tarafından döndürülen benzersiz şablon tanımlayıcısı |
Döndürülenler
- response
- array of contentControlInfoDto
Şablon için başlangıç JSON yükü oluşturma
Belge oluşturma için giriş olarak yeniden kullanılabilmesi için seçilen şablonda bulunan yer tutucularla eşleşen örnek bir JSON yapısı oluşturur
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon tanımlayıcısı
|
templateId | True | uuid |
Şablon kataloğu tarafından döndürülen benzersiz şablon tanımlayıcısı |
Döndürülenler
- response
- object
Şablon için toplu oluşturma işlerini listeleme
TemplateId'nin eşleştiği toplu oluşturma bölümü için tüm işleri döndürür; tek iş durumuyla aynı yük şekli, azalan başlangıç zamanına göre sıralanmış
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon tanımlayıcısı
|
templateId | True | uuid |
Yalnızca bu şablon kimliğiyle başlatılan işler döndürülür |
Döndürülenler
- response
- array of bulkGenerationJobStatusDto
Şablon verilerinden belge oluşturma
Sağlanan JSON yükünü seçili şablonla birleştirir ve oluşturulan belgeyi döndürür. Word çıktı veya .pdf PDF çıkışı için kullanın .docx
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Benzersiz şablon tanımlayıcısı |
|
|
data
|
data | object |
Şablon yer tutucuları için değerler içeren JSON nesnesi. |
|
|
Belge Adı
|
documentName | string |
API'niz uzantı kabul etmediği sürece, oluşturulan belgenin uzantısız adı |
|
|
Format
|
format | string |
Çıkış biçimi. Word belgeleri için .docx veya PDF belgeleri için .pdf kullanın. |
Döndürülenler
- response
- file
Tanımlar
bulkGenerationAcceptedDto
Toplu belge oluşturma işi işlenmek üzere kabul edildiğinde yanıt döndürülür.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İş Kimliği
|
jobId | string |
Benzersiz toplu oluşturma işi tanımlayıcısı. |
|
Başlangıç:
|
startedAt | date-time |
İşlemin başlatılıp başlatılmadığı UTC tarihi ve saati. |
bulkGenerationFailureItemDto
Toplu oluşturma işinde başarısız olan bir belge öğesi hakkında bilgi.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Genel Dizin
|
globalIndex | string |
Başarısız oluşturulan öğenin dizin veya iç tanımlayıcısı. |
|
Dosya Adı
|
fileName | string |
Oluşturulan veya istenen dosya adı. |
|
Error
|
error | string |
Başarısız öğe için hata iletisi. |
bulkGenerationJobStatusDto
Toplu belge oluşturma işi için durum ve sonuç ayrıntıları.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İş Kimliği
|
jobId | string |
Benzersiz toplu oluşturma işi tanımlayıcısı. |
|
Şablon Kimliği
|
templateId | uuid |
Benzersiz şablon tanımlayıcısı. |
|
Status
|
status | string |
Geçerli iş durumu, örneğin: Beklemede, Çalışıyor, Tamamlandı, Başarısız veya Kısmen Tamamlandı. |
|
Başlangıç:
|
startedAt | date-time |
İşlemin başlatılıp başlatılmadığı UTC tarihi ve saati. |
|
Bitiş Saati
|
endTime | date-time |
İşin bittiği UTC tarihi ve saati. |
|
Zip Url'si
|
zipUrl | string |
Oluşturulan ZIP dosyası için geçici indirme URL'si. Toplu oluşturma için bu bağlantı, oluşturma zamanından itibaren 24 saat geçerlidir. |
|
Hata mesajı
|
errorMessage | string |
Düzenleme başarısız olduysa iş düzeyi hata iletisi. |
|
failedGenerations
|
failedGenerations | array of bulkGenerationFailureItemDto |
Toplu oluşturma işi içindeki başarısız öğelerin koleksiyonu. |
|
Başarısız Oluşturma Sayısı
|
failedGenerationCount | integer |
Toplu oluşturma işi içindeki başarısız öğelerin sayısı. |
categoryDto
Şablon kategorisi bilgileri.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | uuid |
Benzersiz tanımlayıcı. |
|
name
|
name | string |
Görünen ad. |
contentControlInfoDto
Şablonda bulunan bir Word içerik denetimi veya yer tutucu için meta veriler.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
title
|
title | string |
İçerik denetimi başlığı. |
|
tag
|
tag | string |
JSON alan anahtarı olarak kullanılan içerik denetimi etiketi. |
|
type
|
type | string |
İçerik denetim türü. |
pagedResponseOffsetDto_templateInfoDto
Şablon kayıtlarını içeren uzaklık tabanlı sayfalanmış yanıt.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
data
|
data | array of templateInfoDto |
Şablon yer tutucuları için değerler içeren JSON nesnesi. |
|
Sayfa Numarası
|
pageNumber | integer |
Geçerli sayfa numarası. |
|
Sayfa Boyutu
|
pageSize | integer |
Sayfa başına kayıt sayısı. |
|
Toplam Kayıt Sayısı
|
totalRecords | integer |
Toplam kullanılabilir kayıt sayısı. |
|
Toplam Sayfa Sayısı
|
totalPages | integer |
Toplam sayfa sayısı. |
templateInfoDto
Şablon listesi uç noktası tarafından döndürülen şablon kataloğu öğesi.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | uuid |
Benzersiz tanımlayıcı. |
|
İsim
|
name | string |
Görünen ad. |
|
Description
|
description | string |
İnsan tarafından okunabilen bir açıklama. |
|
Oluşturulma Tarihi
|
createdOn | date-time |
Şablonun oluşturulduğu UTC tarihi ve saati. |
|
Son Değiştirilme Tarihi
|
lastModified | date-time |
Şablonun en son değiştirildiği UTC tarihi ve saati. |
|
categories
|
categories | array of categoryDto |
Şablon kategorileri. |
dosya
Bu, 'file' temel veri türüdür.
nesne
Bu , 'object' türüdür.