Temp classroomiX (preview)
TempapiiX is een API voor het genereren van documenten voor het maken van DOCX- en PDF-bestanden op basis van herbruikbare Word-sjablonen. Gebruik deze connector om metagegevens van sjablonen te extraheren, één document te genereren, bulksgewijs document genereren uit te voeren, de status van bulktaken te controleren, gegenereerde resultaten te downloaden en abonnements- of gebruiksgegevens weer te geven.
Verificatie wordt uitgevoerd met een API-sleutel doorgegeven.
Gegenereerde bulk-ZIP-downloadkoppelingen zijn 24 uur geldig.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Temp cachingiX-ondersteuning |
| URL | https://templionix.com |
| E-mailadres | support@templionix.com |
| Connectormetagegevens | |
|---|---|
| Publisher | Temp cachingiX |
| Website | https://templionix.com |
| Privacybeleid | https://templionix.com/privacy-policy |
| Gebruiksvoorwaarden | https://templionix.com/terms-of-use |
| Categorieën | Productiviteit; Inhoud en bestanden |
| IconBrandColor | #333A41 |
Temp cachingiX-connector
Overview
TempanyiX is een service voor het genereren van documenten waarmee u DOCX- en PDF-bestanden kunt maken op basis van herbruikbare Microsoft Word sjablonen en gestructureerde JSON-gegevens.
Met deze connector kunnen gebruikers Microsoft Power Automate, Power Apps, Azure Logic Apps en Copilot Studio werkstromen verbinden met de TempapiiX-API. Gebruikers kunnen metagegevens van sjablonen extraheren, starter JSON-nettoladingen genereren, documenten genereren, bulksgewijs genereren van documenten uitvoeren, de taakstatus controleren, gegenereerde resultaten downloaden en beschikbare sjablonen ophalen.
Publisher
Temp cachingiX
Beoogde Microsoft producten
- Microsoft Power Automate
De connector wordt geïmplementeerd als een Microsoft Power Platform aangepaste connector en kan worden gebruikt in andere Microsoft connectorervaringen waar gecertificeerde connectors worden ondersteund.
Authentication
De connector maakt gebruik van API-sleutelverificatie. De API-sleutel wordt doorgegeven in de x-functions-key aanvraagheader.
Gebruikers moeten een actief TempapiiX-account en een geldige API-sleutel hebben om deze connector te kunnen gebruiken.
Belangrijkste mogelijkheden
Sjablonen ophalen
Hiermee haalt u een gepagineerde lijst met beschikbare documentsjablonen op uit TempcacheiX. Deze bewerking kan worden gebruikt om een sjabloon te selecteren voordat metagegevens, een startersmodel, één document of een taak voor het genereren van bulksgewijs documenten worden gegenereerd.
Sjabloonvelden en tijdelijke aanduidingen extraheren
Extraheert metagegevens uit een geselecteerde sjabloon, inclusief sjabloonvelden en tijdelijke aanduidingen. Dit helpt gebruikers te begrijpen welke gegevens door de sjabloon worden verwacht.
Een eenvoudige JSON-nettolading genereren voor een sjabloon
Hiermee wordt een voorbeeld van een JSON-nettolading gegenereerd op basis van de geselecteerde sjabloon. Gebruikers kunnen deze nettolading gebruiken als uitgangspunt voor het toewijzen van gegevens van andere systemen in een aanvraag voor het genereren van documenten.
Een document genereren
Hiermee wordt een DOCX- of PDF-document gegenereerd op basis van een geselecteerde sjabloon en JSON-gegevens ingevoerd.
Documenten bulksgewijs genereren
Hiermee start u een taak voor het genereren van bulkdocumenten met behulp van een geselecteerde sjabloon en meerdere invoerrecords. Gegenereerde bulk-ZIP-downloadkoppelingen zijn 24 uur geldig.
Taakstatus bulksgewijs genereren ophalen
Haalt de status- en resultaatinformatie op voor een specifieke taak voor het genereren van bulksgewijs documenten.
Taken voor bulksgewijs genereren op sjabloon ophalen
Hiermee worden bulksgewijs gegenereerde taken opgehaald die zijn gekoppeld aan een geselecteerde sjabloon.
Algemene gebruiksscenario's
- Genereer contracten, facturen, voorstellen, rapporten, brieven en andere zakelijke documenten op basis van gestructureerde gegevens.
- Automatiseer het maken van documenten vanuit CRM, ERP, formulieren, Excel, SharePoint, Dataverse-, SQL- of API-systemen.
- Eén document op aanvraag maken op basis van een werkstroom.
- Genereer meerdere documenten bulksgewijs en haal het gegenereerde ZIP-resultaat op.
- Gebruik geëxtraheerde sjabloonmetagegevens om te begrijpen welke velden vereist zijn voor het genereren van documenten.
Voorbeeldwerkstroom
- Een stroom handmatig of vanuit een bedrijfsgebeurtenis activeren.
- Gebruik de bewerking Sjablonen ophalen om een sjabloon te selecteren.
- Gebruik de bewerking Een eenvoudige JSON-nettolading genereren om inzicht te hebben in de verwachte gegevensstructuur.
- Bronsysteemgegevens toewijzen aan de gegenereerde JSON-structuur.
- Gebruik de bewerking Een document genereren om een DOCX- of PDF-bestand te maken.
- Sla het gegenereerde bestand op in OneDrive, SharePoint, Dataverse, e-mail of een andere bestemming.
Support
Voor productinformatie, documentatie en ondersteuning gaat u naar:
- Website: https://templionix.com
- Documentatie: https://docs.templionix.com
- Ondersteuning: https://templionix.com/contact
- Privacybeleid: https://templionix.com/privacy-policy
- Gebruiksvoorwaarden: https://templionix.com/terms-of-use
Opmerkingen voor certificeringsbeoordeling
Dit pakket bevat de Temp cachingiX-connectoroplossing en een voorbeeldstroomoplossing die de connectorbewerkingen demonstreert. De connector communiceert met de productie TempapiiX-API en maakt gebruik van API-sleutelverificatie via de x-functions-key header.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Name | Type | Description | Required |
|---|---|---|---|
| TempapiiX API-sleutel | beveiligde string | De TempapiiX API-sleutel voor deze API | True |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Beschikbare sjablonen weergeven |
Retourneert een gepagineerde lijst met sjablonen die kunnen worden gebruikt met metagegevensextractie, modelgeneratie en eindpunten voor het genereren van documenten |
| Bulksgewijs genereren van documenten starten |
Start bulktaak om documenten te genereren op basis van een gedeelde sjabloon, bouwt een ZIP met een lees-SAS-URL en houdt de voortgang bij. Retourneert de taak-id onmiddellijk. De geretourneerde ZIP-download-URL is beschikbaar nadat de taak is voltooid en gedurende 24 uur geldig is vanaf de generatietijd. |
| Een document genereren op basis van sjabloongegevens |
Voegt de opgegeven JSON-nettolading samen met de geselecteerde sjabloon en retourneert het gegenereerde document. Gebruiken |
| Een eenvoudige JSON-nettolading genereren voor een sjabloon |
Hiermee wordt een voorbeeld van een JSON-structuur gemaakt die overeenkomt met de tijdelijke aanduidingen die zijn gedetecteerd in de geselecteerde sjabloon, zodat deze opnieuw kan worden gebruikt als invoer voor het genereren van documenten |
| Sjabloonvelden en tijdelijke aanduidingen extraheren |
Leest de geselecteerde sjabloon en retourneert de inhoudsbesturingselementen die in het document zijn gedetecteerd, inclusief hun titel, tag, type en vooraf gedefinieerde waarden, indien beschikbaar. |
| Taakstatus bulksgewijs genereren ophalen |
Laadt de status van de taak op id: status, begin-/eindtijden, ZIP SAS-URL wanneer voltooid, indelingsfout wanneer mislukt en geparseerde fouten per item genereren. |
| Taken voor bulksgewijs genereren voor een sjabloon vermelden |
Retourneert alle taken voor de partitie voor bulksgewijs genereren waarbij TemplateId overeenkomt; dezelfde nettoladingshape als status van één taak, gesorteerd op aflopende begintijd |
Beschikbare sjablonen weergeven
Retourneert een gepagineerde lijst met sjablonen die kunnen worden gebruikt met metagegevensextractie, modelgeneratie en eindpunten voor het genereren van documenten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Paginanummer
|
pageNumber | True | integer |
Op 1 gebaseerde pagina-index die moet worden geretourneerd |
|
Paginaformaat
|
pageSize | True | integer |
Maximum aantal sjablonen dat in één antwoord moet worden geretourneerd |
Retouren
Op offset gebaseerde gepaginade respons met sjabloonrecords.
Bulksgewijs genereren van documenten starten
Start bulktaak om documenten te genereren op basis van een gedeelde sjabloon, bouwt een ZIP met een lees-SAS-URL en houdt de voortgang bij. Retourneert de taak-id onmiddellijk. De geretourneerde ZIP-download-URL is beschikbaar nadat de taak is voltooid en gedurende 24 uur geldig is vanaf de generatietijd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Unieke sjabloon-id |
|
|
Format
|
format | string |
Uitvoerindeling. Gebruik .docx voor Word documenten of .pdf voor PDF-documenten |
|
|
Bestandsnaam
|
fileName | string |
Gegenereerde of aangevraagde bestandsnaam |
|
|
items
|
items | object |
Retouren
Antwoord geretourneerd wanneer een bulktaak voor het genereren van documenten is geaccepteerd voor verwerking.
Een document genereren op basis van sjabloongegevens
Voegt de opgegeven JSON-nettolading samen met de geselecteerde sjabloon en retourneert het gegenereerde document. Gebruiken .docx voor Word uitvoer of .pdf voor PDF-uitvoer
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Template
|
templateId | uuid |
Unieke sjabloon-id |
|
|
data
|
data | object |
JSON-object met waarden voor tijdelijke aanduidingen voor sjablonen. |
|
|
Documentnaam
|
documentName | string |
Naam van het gegenereerde document zonder extensie, tenzij uw API een extensie accepteert |
|
|
Format
|
format | string |
Uitvoerindeling. Gebruik .docx voor Word documenten of .pdf voor PDF-documenten. |
Retouren
- response
- file
Een eenvoudige JSON-nettolading genereren voor een sjabloon
Hiermee wordt een voorbeeld van een JSON-structuur gemaakt die overeenkomt met de tijdelijke aanduidingen die zijn gedetecteerd in de geselecteerde sjabloon, zodat deze opnieuw kan worden gebruikt als invoer voor het genereren van documenten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-id
|
templateId | True | uuid |
Unieke sjabloon-id geretourneerd door de sjablooncatalogus |
Retouren
- response
- object
Sjabloonvelden en tijdelijke aanduidingen extraheren
Leest de geselecteerde sjabloon en retourneert de inhoudsbesturingselementen die in het document zijn gedetecteerd, inclusief hun titel, tag, type en vooraf gedefinieerde waarden, indien beschikbaar.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-id
|
templateId | True | uuid |
Unieke sjabloon-id geretourneerd door de sjablooncatalogus |
Retouren
- response
- array of contentControlInfoDto
Taakstatus bulksgewijs genereren ophalen
Laadt de status van de taak op id: status, begin-/eindtijden, ZIP SAS-URL wanneer voltooid, indelingsfout wanneer mislukt en geparseerde fouten per item genereren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bulktaak-id
|
jobId | True | string |
Taak-id geretourneerd in het antwoord generateDocumentsBulk 202 ( |
Retouren
Status- en resultaatdetails voor een bulktaak voor het genereren van documenten.
Taken voor bulksgewijs genereren voor een sjabloon vermelden
Retourneert alle taken voor de partitie voor bulksgewijs genereren waarbij TemplateId overeenkomt; dezelfde nettoladingshape als status van één taak, gesorteerd op aflopende begintijd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-id
|
templateId | True | uuid |
Alleen taken die met deze sjabloon-id zijn gestart, worden geretourneerd |
Retouren
- response
- array of bulkGenerationJobStatusDto
Definities
bulkGenerationAcceptedDto
Antwoord geretourneerd wanneer een bulktaak voor het genereren van documenten is geaccepteerd voor verwerking.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Job-ID
|
jobId | string |
Unieke taak-id voor het genereren van bulksgewijs genereren. |
|
Gestart bij
|
startedAt | date-time |
UTC-datum en -tijd waarop de bewerking is gestart. |
bulkGenerationFailureItemDto
Informatie over één mislukt documentitem in een taak voor bulksgewijs genereren.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Globale index
|
globalIndex | string |
Index of interne id van het mislukte gegenereerde item. |
|
Bestandsnaam
|
fileName | string |
Gegenereerde of aangevraagde bestandsnaam. |
|
Fout
|
error | string |
Foutbericht voor het mislukte item. |
bulkGenerationJobStatusDto
Status- en resultaatdetails voor een bulktaak voor het genereren van documenten.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Job-ID
|
jobId | string |
Unieke taak-id voor het genereren van bulksgewijs genereren. |
|
Sjabloon-ID
|
templateId | uuid |
Unieke sjabloon-id. |
|
Status
|
status | string |
Huidige taakstatus, bijvoorbeeld: In behandeling, Actief, Voltooid, Mislukt of Gedeeltelijk voltooid. |
|
Gestart bij
|
startedAt | date-time |
UTC-datum en -tijd waarop de bewerking is gestart. |
|
Eindtijd
|
endTime | date-time |
UTC-datum en -tijd waarop de taak is voltooid. |
|
Zip-URL
|
zipUrl | string |
Tijdelijke download-URL voor het gegenereerde ZIP-bestand. Voor het genereren van bulksgewijs is deze koppeling 24 uur geldig vanaf de generatietijd. |
|
Foutmelding
|
errorMessage | string |
Foutbericht op taakniveau als de indeling is mislukt. |
|
failedGenerations
|
failedGenerations | array of bulkGenerationFailureItemDto |
Verzameling mislukte items in een bulkgeneratietaak. |
|
Aantal mislukte generatie
|
failedGenerationCount | integer |
Aantal mislukte items in een bulkgeneratietaak. |
categoryDto
Informatie over sjablooncategorie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid |
Unieke id. |
|
name
|
name | string |
Weergavenaam. |
contentControlInfoDto
Metagegevens voor één Word inhoudsbeheer of tijdelijke aanduiding die in een sjabloon zijn gedetecteerd.
| Name | Pad | Type | Description |
|---|---|---|---|
|
title
|
title | string |
Titel van inhoudsbeheer. |
|
tag
|
tag | string |
Tag voor inhoudsbeheer die wordt gebruikt als een JSON-veldsleutel. |
|
type
|
type | string |
Type inhoudsbeheer. |
pagedResponseOffsetDto_templateInfoDto
Op offset gebaseerde gepaginade respons met sjabloonrecords.
| Name | Pad | Type | Description |
|---|---|---|---|
|
data
|
data | array of templateInfoDto |
JSON-object met waarden voor tijdelijke aanduidingen voor sjablonen. |
|
Paginanummer
|
pageNumber | integer |
Huidig paginanummer. |
|
Paginagrootte
|
pageSize | integer |
Aantal records per pagina. |
|
Totaal aantal records
|
totalRecords | integer |
Totaal aantal beschikbare records. |
|
Totaal aantal pagina's
|
totalPages | integer |
Totaal aantal pagina's. |
templateInfoDto
Sjablooncatalogusitem geretourneerd door het eindpunt van de sjabloonlijst.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Id
|
id | uuid |
Unieke id. |
|
Name
|
name | string |
Weergavenaam. |
|
Description
|
description | string |
Leesbare beschrijving. |
|
Gemaakt op
|
createdOn | date-time |
UTC-datum en -tijd waarop de sjabloon is gemaakt. |
|
Laatst gewijzigd
|
lastModified | date-time |
UTC-datum en -tijd waarop de sjabloon voor het laatst is gewijzigd. |
|
categories
|
categories | array of categoryDto |
Sjablooncategorieën. |
bestand
Dit is het basisgegevenstype 'bestand'.
object
Dit is het type 'object'.