Udostępnij przez

APITemplate (niezależny wydawca)

Usługa APITemplate.io umożliwia tworzenie dokumentów PDF i obrazów oraz zarządzanie szablonami. Generuj obrazy mediów społecznościowych, banery lub pliki PDF z szablonów wielokrotnego użytku bez kodowania!

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Troy Taylor
adres URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor
Witryna internetowa https://apitemplate.io/
Zasady ochrony prywatności https://apitemplate.io/privacy-policy/
Kategorie Zawartość i pliki

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Klucz interfejsu API securestring Klucz interfejsu API dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie szablonu PDF

Ta akcja aktualizuje szablon PDF.
Pobieranie szablonu PDF

Pobiera informacje o szablonie PDF.
Scalanie wielu plików PDF

Ta akcja scala/łączy wiele plików PDF z jednym plikiem PDF.
Szablony list

Pobiera listę szablonów i ich informacje.
Tworzenie obrazu

To żądanie tworzy plik JPEG (wraz z plikiem PNG) na podstawie danych JSON i szablonu.
Tworzenie pliku PDF

To żądanie tworzy plik PDF z danymi JSON i szablonem. Obsługuje synchroniczne i asynchroniczne generowanie plików PDF.
Usuwanie obiektu

Usuń plik PDF lub obraz z usługi CDN i oznacz transakcję jako usuniętą.
Wyświetlanie listy wygenerowanych obiektów

Pobiera listę wszystkich wygenerowanych plików PDF i obrazów.

Aktualizowanie szablonu PDF

Identyfikator operacji:
TemplateUpdate

Ta akcja aktualizuje szablon PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator szablonu
 template_id True string

Identyfikator szablonu można uzyskać w konsoli sieci Web (Zarządzanie szablonami)
Body
 body string

Treść HTML
CSS
 css string

Arkusz css

Zwraca

ResponseSuccess
ResponseSuccess

Pobieranie szablonu PDF

Identyfikator operacji:
TemplateGet

Pobiera informacje o szablonie PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator szablonu
 template_id string

Identyfikator szablonu można uzyskać w konsoli sieci Web (Zarządzaj szablonami)

Zwraca

ResponseSuccessTemplate
ResponseSuccessTemplate

Scalanie wielu plików PDF

Identyfikator operacji:
PDFMerge

Ta akcja scala/łączy wiele plików PDF z jednym plikiem PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Meta
 meta string

Określ identyfikator odwołania zewnętrznego dla własnego odwołania. Pojawia się on w interfejsie list-objects API.
Adresy URL
 urls True array of string

Tablica adresów URL. Obsługujemy normalne adresy URL i adresy URL danych http/https. Zwykłe adresy URL: adresy URL zaczynają się od http/https, np. "https://fileserver.com/a1.pdf"). Adresy URL danych: adresy URL poprzedzone schematem "data:", np. "data:application/pdf; base64,JVBERi0xLjIg.. [obcięte]"
Typ eksportu
 export_type string

Albo file lub json(wartość domyślna). Opcja json zwraca obiekt JSON, a wyjściowy plik PDF jest przechowywany w usłudze CDN. Opcja file zwraca dane binarne wygenerowanego pliku PDF(Bezpieczne i całkowicie prywatne), a nagłówek HTTP odpowiedzi Content-Disposition jest ustawiony na załącznik. Ma limit rozmiaru pliku 6 MB.
Wygaśnięcie
 expiration integer

Wygaśnięcie wygenerowanego pliku PDF w minutach (wartość domyślna to 0, zapisz trwale). Służy 0 do trwałego przechowywania w usłudze cdn. Możesz też użyć zakresu między minutami a 43200 minutami 1 (30 dni), aby określić wygaśnięcie wygenerowanego pliku PDF
Magazyn w chmurze
 cloud_storage integer

Przekaż wygenerowane pliki PDF/images do naszej sieci CDN magazynu, domyślnie na 1wartość . Jeśli skonfigurowano Post Action przekazywanie plików PDF/obrazów do własnego S3, ustaw go na 0wartość .

Zwraca

ResponseSuccessSingleFile
ResponseSuccessSingleFile

Szablony list

Identyfikator operacji:
TemplatesGet

Pobiera listę szablonów i ich informacje.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ograniczenie
 limit string

Pobierz tylko określoną liczbę rekordów. Wartość domyślna to 300
Przesunięcie
 offset string

Przesunięcie służy do pomijania liczby rekordów z wyników. Wartość domyślna to 0
Format
 format string

Aby filtrować szablony według formatu "PDF" lub "JPEG"
Identyfikator szablonu
 template_id string

Aby filtrować szablony według identyfikatora szablonu
Nazwa grupy
 group_name string

Aby filtrować szablony według nazwy grupy
Z informacjami o warstwie
 with_layer_info string

Zwracaj wraz z informacjami o warstwie dla szablonów obrazów, 0=false , 1=true. Wartość domyślna to "0"

Zwraca

ResponseSuccessListTemplates
ResponseSuccessListTemplates

Tworzenie obrazu

Identyfikator operacji:
ImagePost

To żądanie tworzy plik JPEG (wraz z plikiem PNG) na podstawie danych JSON i szablonu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator szablonu
 template_id True string

Identyfikator szablonu można uzyskać w konsoli sieci Web
Wygaśnięcie
 expiration integer

Wygaśnięcie wygenerowanego obrazu w minutach (domyślnie do 0, zapisz trwale). Służy 0 do trwałego przechowywania w usłudze cdn. Możesz też użyć zakresu między minutami 1 a 10080 minutami (7 dni), aby określić wygaśnięcie wygenerowanego obrazu
Magazyn w chmurze
 cloud_storage integer

Przekaż wygenerowane pliki PDF/obrazy do naszej sieci CDN magazynu i wygeneruj adres URL domyślnie .1 Jeśli skonfigurowano Post Actions element w pliku w API Integration celu przekazania wygenerowanych plików PDF/Obrazów do własnej prywatnej usługi S3, ustaw cloud_storage na 0wartość . Jeśli element , zignoruj export_type=fileto.
Typ obrazu wyjściowego
 output_image_type string

Typ obrazu wyjściowego (format JPEG lub PNG), wartość domyślna to all. Opcje to all, ,pngOnlyjpegOnly .
Meta
 meta string

Określ identyfikator odwołania zewnętrznego dla własnego odwołania. Pojawia się on w interfejsie list-objects API.
object

Zwraca

ResponseSuccessImageFile
ResponseSuccessImageFile

Tworzenie pliku PDF

Identyfikator operacji:
PDFPost

To żądanie tworzy plik PDF z danymi JSON i szablonem. Obsługuje synchroniczne i asynchroniczne generowanie plików PDF.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator szablonu
 template_id True string

Identyfikator szablonu można uzyskać w konsoli sieci Web (Zarządzaj szablonami)
Typ eksportu
 export_type string

Albo file lub json(wartość domyślna). Opcja json zwraca obiekt JSON, a wyjściowy plik PDF jest przechowywany w usłudze CDN. Użyj tego parametru z parametrem expiration. Opcja file zwraca dane binarne wygenerowanego pliku PDF(Bezpieczne i całkowicie prywatne), a nagłówek HTTP odpowiedzi Content-Disposition jest ustawiony na załącznik.
Wygaśnięcie
 expiration integer

Wygaśnięcie wygenerowanego pliku PDF w minutach (wartość domyślna to 0, zapisz trwale). Służy 0 do trwałego przechowywania w usłudze cdn. Możesz też użyć zakresu między minutami 1 a 10080 minutami (7 dni), aby określić wygaśnięcie wygenerowanego pliku PDF
Wyjściowy kod HTML
 output_html string

Albo 1 lub 0(wartość domyślna).. Aby włączyć dane wyjściowe zawartości HTML, ustaw wartość 1 na i zostanie zwrócona w odpowiedzi JSON jako pole html_url (jako adres URL)
Format danych wyjściowych
 output_format string

pdfAlbo (wartość domyślna) lub html.. Domyślnie generuje plik PDF. Można jednak określić output_format=html, aby wygenerować tylko kod HTML (zostanie zwrócony w odpowiedzi JSON jako pole download_url jako adres URL).
Filename
 filename string

Wartość domyślna to UUID (np. 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Użyj tej opcji, aby określić niestandardową nazwę pliku. Powinna ona kończyć się ciągiem .pdf
Duża ponowna ponowna próbkowanie
 image_resample_res string

Domyślnie osadzamy oryginalne obrazy, co oznacza duże rozmiary plików PDF. Określenie opcji "image_resample_res" pomaga zmniejszyć rozmiar pliku PDF przez downsampling obrazów bieżącego pliku PDF do rozdzielczości (w DPI). Typowe wartości to 72, 96, 150, 300 i 600.
Czy CMYK
 is_cmyk string

Użyj profilu koloru CMYK, 1=true, 0 =false. Wartość domyślna to "0"
Magazyn w chmurze
 cloud_storage integer

Przekaż wygenerowane pliki PDF/images do naszej sieci CDN magazynu, domyślnie na 1wartość . Jeśli skonfigurowano Post Action przekazywanie plików PDF/obrazów do własnego S3, ustaw go na 0wartość .
Meta
 meta string

Określ identyfikator odwołania zewnętrznego dla własnego odwołania. Pojawia się on w interfejsie list-objects API.
Async
 async string

Albo 1 lub 0(wartość domyślna). 0 to synchroniczne wywołanie (domyślne), 1 jest wywołaniem asynchronicznym. Aby wygenerować plik PDF asynchronicznie, ustaw wartość na 1 , a wywołanie interfejsu API zwraca natychmiast. Po wygenerowaniu dokumentu PDF utworzymy adres URL HTTP/HTTPS GET (webhook_url) i ponowimy próbę przez 3 razy przed rezygnacją. Jeśli async jest ustawiona wartość 1, webhook_url wartość jest obowiązkowa
Webhook URL
 webhook_url string

Jest to adres URL adresu URL elementu webhook, zaczyna się od http:// lub https:// i musi być zakodowany w adresie URL. Jeśli async jest ustawiona wartość 1, musisz określić wartość webhook_url. Format wywołania zwrotnego elementu webhookOnce generowany jest plik PDF. Zainicjujemy wywołanie HTTP/HTTPS GET do następującego adresu URL:https://[yourwebserver.com]?&primary_url=[primary_url]&transaction_ref=[transaction_ref]&status=&message=[status][message]. [yourwebserver.com]: usługi sieci Web do obsługi wywołania zwrotnego, czyli webhook_url. [primary_url]: adres URL dokumentu PDF. [transaction_ref]: numer referencyjny transakcji. [status] : stan transakcji lub successerror. [message] : komunikat o stanieNastępujący kod to przykładowe wywołanie elementu webhook z powrotem do serwerahttps://yourwebserver.com?& primary_url=https%3A%2F%2Fpub-cdn.apitemplate.io%2F2021%2F06%2Fb692183d-46d7-3213-891a-460a5814ad3f.pdf&transaction_ref=b692183d-46d7-3213-891a-460a5814ad3f&status=success
object

Zwraca

ResponseSuccessPDFFile
ResponseSuccessPDFFile

Usuwanie obiektu

Identyfikator operacji:
ObjectDelete

Usuń plik PDF lub obraz z usługi CDN i oznacz transakcję jako usuniętą.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ref transakcji
 transaction_ref True string

Odwołanie do transakcji obiektów

Zwraca

ResponseSuccessDeleteObject
ResponseSuccessDeleteObject

Wyświetlanie listy wygenerowanych obiektów

Identyfikator operacji:
ObjectsGet

Pobiera listę wszystkich wygenerowanych plików PDF i obrazów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Ograniczenie
 limit string

Pobierz tylko określoną liczbę rekordów. Wartość domyślna to 300
Przesunięcie
 offset string

Przesunięcie służy do pomijania liczby rekordów z wyników. Wartość domyślna to 0
Identyfikator szablonu
 template_id string

Filtrowane według identyfikatora szablonu
Typ transakcji
 transaction_type string

Filtrowane według typu transakcji, opcje to PDF, JPEG lub MERGE

Zwraca

ResponseSuccessListObjects
ResponseSuccessListObjects

Definicje

ResponseSuccess

Nazwa Ścieżka Typ Opis
Status
 status string

Status

ResponseSuccessTemplate

Nazwa Ścieżka Typ Opis
Status
 status string

Status
Identyfikator szablonu
 template_id string

Identyfikator szablonu
Body
 body string

Treść HTML szablonu
CSS
 css string

Arkusz CSS szablonu
Ustawienia
 settings string

Ustawienia drukowania szablonu

ResponseSuccessPDFFile

Nazwa Ścieżka Typ Opis
Status
 status string

Status
Adres URL pobierania
 download_url string

Adres URL pobierania
Identyfikator szablonu
 template_id string

Identyfikator szablonu
Ref transakcji
 transaction_ref string

Dokumentacja transakcji
Akcje ogłaszane
 post_actions array of object

Akcje postu.
items
 post_actions object

ResponseSuccessImageFile

Nazwa Ścieżka Typ Opis
Status
 status string

Status
Adres URL pobierania
 download_url string

Adres URL pobierania
Pobierz adres URL PNG
 download_url_png string

Pobierz adres URL PNG
Identyfikator szablonu
 template_id string

Identyfikator szablonu
Ref transakcji
 transaction_ref string

Dokumentacja transakcji
Akcje ogłaszane
 post_actions array of object

Akcje postu.
items
 post_actions object

ResponseSuccessListTemplates

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Szablony
 templates array of object

Szablony
items
 templates object

ResponseSuccessListObjects

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.
Objects
 objects array of object

Obiekty.
items
 objects object

ResponseSuccessDeleteObject

Nazwa Ścieżka Typ Opis
Status
 status string

Stan.

ResponseSuccessSingleFile

Nazwa Ścieżka Typ Opis
Status
 status string

Status
Podstawowy adres URL
 primary_url string

Wygenerowany dokument PDF
Ref transakcji
 transaction_ref string

Dokumentacja transakcji