CivicPlus Transform
Umożliwia użytkownikom biznesowym tworzenie i wdrażanie formularzy cyfrowych dla organizacji korporacyjnych i rządowych jako aplikacji internetowych i natywnych, umożliwiając deweloperom dostosowywanie, rozszerzanie lub wykorzystywanie formularzy za pomocą własnych aplikacji niestandardowych. Połącz formularze z tym łącznikiem, aby umożliwić łatwe przesyłanie danych formularza do systemów zaplecza lub baz danych bez konieczności pisania złożonego kodu integracji.
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 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 (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - 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 High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | CivicPlus Support |
| adres URL | https://www.civicoptimize.civicplus.help/hc/en-us |
| support@civicplus.com |
| Metadane łącznika | |
|---|---|
| Publisher | OneBlink |
| Witryna internetowa | http://oneblink.io/ |
| Zasady ochrony prywatności | http://oneblink.io/legal/privacy-policy |
| Kategorie | Produktywność; Dane |
Łącznik transformacji CivicPlus
Umożliwia użytkownikom biznesowym tworzenie i wdrażanie formularzy cyfrowych dla organizacji korporacyjnych i rządowych jako aplikacji internetowych i natywnych, umożliwiając deweloperom dostosowywanie, rozszerzanie lub wykorzystywanie formularzy za pomocą własnych aplikacji niestandardowych. Połącz formularze z tym łącznikiem, aby umożliwić łatwe przesyłanie danych formularza do systemów zaplecza lub baz danych bez konieczności pisania złożonego kodu integracji.
Pre-requisites
- Musisz zalogować się do aplikacji CivicPlus Transform Productivity Suite przy użyciu swojego adresu e-mail.
- Przejdź do
Developer Keyssekcji konsoli i utwórz nowy klucz interfejsu API z uprawnieniemFormswłączonym.
Dokumentacja
Aby uzyskać więcej informacji na temat sposobu konfigurowania łącznika, zapoznaj się z naszym artykułem pomocy technicznej tutaj.
Obsługiwane operacje
Łącznik obsługuje następujące operacje:
FormSubmissionMetaWebhookTrigger: Tworzy element meta webhook przesyłania formularza CivicPlus
Zwraca:
| Name | Ścieżka | Typ |
|---|---|---|
| Identyfikator formularza | formId | liczba całkowita |
| Identyfikator przesyłania | ID zgłoszenia | ciąg |
GetFormSubmissionData: Umożliwia pobieranie danych przesyłania formularzy CivicPlus
Parametry:
| Name | Key | Wymagane | Typ | Description |
|---|---|---|---|---|
| Identyfikator formularza | formId | true | liczba całkowita | Identyfikator pobieranego formularza |
| Identyfikator przesyłania | ID zgłoszenia | true | ciąg | Identyfikator pobieranego przesyłania formularza |
GetFormSubmissionAttachment: Pobiera załączniki skojarzone z przesłaniem formularza CivicPlus
Parametry:
| Name | Key | Wymagane | Typ | Description |
|---|---|---|---|---|
| Identyfikator formularza | formId | true | liczba całkowita | Identyfikator formularza, za pomocą którego przekazano załącznik |
| Identyfikator załącznika | attachmentId | true | ciąg | Identyfikator przekazanego załącznika |
GenerateFormSubmissionPDF: umożliwia wygenerowanie pliku PDF przesyłania formularza
Parametry:
| Name | Key | Wymagane | Typ | Description |
|---|---|---|---|---|
| Identyfikator formularza | formId | true | liczba całkowita | Identyfikator przesłanego formularza |
| Identyfikator przesyłania | ID zgłoszenia | true | ciąg | Identyfikator przesyłania formularza |
| Uwzględnij identyfikator przesyłania w pliku PDF | includeSubmissionIdInPdf | true | typ logiczny (boolowski) | Identyfikator przesyłania można uwzględnić w dolnej części każdej strony w pliku PDF |
Instrukcje dotyczące wdrażania
Skorzystaj z tych instrukcji , aby wdrożyć ten łącznik jako łącznik niestandardowy w usługach Microsoft Power Automate i Power Apps.
Dalsza pomoc techniczna
Aby uzyskać dalszą pomoc, możesz skontaktować się z nami pod adresem support@civicplus.com - zawsze chętnie pomożemy.
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
| Generuj plik PDF przesyłania formularza |
Umożliwia wygenerowanie pliku PDF przesyłania formularza |
|
Get Civic |
Umożliwia pobranie płatności CivicPlus Pay |
| Pobieranie danych przesyłania formularza |
Umożliwia pobranie danych przesyłania formularza |
| Pobieranie rekordu zatwierdzenia |
Umożliwia pobranie danych zatwierdzenia formularza dla jednego kroku |
| Pobieranie załącznika do przesyłania formularza |
Umożliwia pobieranie załączników do przesyłania formularza |
Generuj plik PDF przesyłania formularza
Umożliwia wygenerowanie pliku PDF przesyłania formularza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator formularza
|
formId | True | integer |
Identyfikator przesłanego formularza |
|
Identyfikator przesyłania
|
submissionId | True | string |
Identyfikator przesyłania formularza |
|
Uwzględnij identyfikator przesyłania w pliku PDF
|
includeSubmissionIdInPdf | boolean |
Identyfikator przesyłania można uwzględnić w dolnej części każdej strony w pliku PDF |
|
|
Uwzględnij szczegóły płatności w pliku PDF
|
includePaymentInPdf | boolean |
Szczegóły płatności można uwzględnić jako ostatnią stronę w pliku PDF |
|
|
Podział strony na stronach formularza
|
usePagesAsBreaks | boolean |
Strony formularzy można tłumaczyć na podziały stron w pliku PDF |
|
|
Wykluczone elementy formularza
|
excludedElementIds | array of string |
Identyfikatory elementów formularza do wykluczenia z pliku PDF |
|
|
Dołącz szczegóły zatwierdzenia do pliku PDF
|
value | string | ||
|
Rozmiar strony PDF
|
pdfSize | string |
Zwraca
Zawartość pliku wyjściowego z usługi PDF
- Zawartość pliku PDF przesyłania formularza
- binary
Get CivicPlus Pay Payment
Umożliwia pobranie płatności CivicPlus Pay
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przesyłania
|
submissionId | True | string |
Identyfikator przesyłania formularza |
Zwraca
Pobieranie danych przesyłania formularza
Umożliwia pobranie danych przesyłania formularza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator formularza
|
formId | True | integer |
Identyfikator pobieranego formularza |
|
Identyfikator przesyłania
|
submissionId | True | string |
Identyfikator pobieranego przesyłania formularza |
Zwraca
- Body
- FormSubmissionData
Pobieranie rekordu zatwierdzenia
Umożliwia pobranie danych zatwierdzenia formularza dla jednego kroku
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przesyłania
|
submissionId | True | string |
Identyfikator przesyłania formularza |
|
Form
|
formId | True | integer |
Formularz do wybrania kroku zatwierdzenia |
|
Krok zatwierdzania
|
approvalLabel | True | string |
Krok zatwierdzania w celu pobrania rekordu zatwierdzenia |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Zatwierdzone przez: adres e-mail
|
formSubmissionApproval.updatedBy | date-time | |
|
Zatwierdzony znacznik czasu
|
formSubmissionApproval.updatedAt | date-time | |
|
Identyfikator formularza zatwierdzenia
|
formSubmissionApproval.approvalFormId | number | |
|
Identyfikator przesyłania formularza zatwierdzenia
|
formSubmissionApproval.approvalFormSubmissionId | string |
Pobieranie załącznika do przesyłania formularza
Umożliwia pobieranie załączników do przesyłania formularza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator formularza
|
formId | True | integer |
Identyfikator formularza, za pomocą którego przekazano załącznik |
|
Identyfikator załącznika
|
attachmentId | True | string |
Identyfikator przekazanego załącznika |
Zwraca
Zawartość pliku wyjściowego załącznika formularza
- Zawartość załącznika
- binary
Wyzwalacze
| Wyzwalacze po przesłaniu formularza |
Tworzy meta element webhook przesyłania formularza |
Wyzwalacze po przesłaniu formularza
Tworzy meta element webhook przesyłania formularza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Etykieta
|
label | string |
Etykieta do wyświetlenia w aplikacji CivicOptimize Productivity w celu zidentyfikowania zdarzenia przepływu pracy |
|
|
Form
|
formId | number |
Wybierz formularz, aby ograniczyć ten przepływ do przesłanych formularzy |
|
|
Wyzwalacz
|
trigger | string |
Wybierz, kiedy ten wyzwalacz wystąpi |
Zwraca
Definicje
FormSubmissionMetaWebhookPush
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator formularza
|
formId | integer | |
|
Identyfikator przesyłania
|
submissionId | string | |
|
Identyfikator zewnętrzny
|
externalId | string | |
|
Identyfikator aplikacji
|
formsAppId | integer |
FormSubmissionData
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa formularza
|
definition.name | string | |
|
Opis formularza
|
definition.description | string | |
|
Dane przesyłania
|
submission | object | |
|
Przesłane przez: adres IP
|
ipAddress | string | |
|
Znacznik czasu przesyłania
|
submissionTimestamp | date-time | |
|
Przesłane przez: identyfikator użytkownika
|
user.providerUserId | string | |
|
Przesłane przez: imię
|
user.firstName | string | |
|
Przesłane przez: Nazwisko
|
user.lastName | string | |
|
Przesłane przez: imię i nazwisko
|
user.fullName | string | |
|
Przesłane przez: adres e-mail
|
user.email | string | |
|
Przesłane przez: adres URL obrazu
|
user.picture | string | |
|
Przesłane przez: Rola
|
user.role | string | |
|
Przesłane przez: wewnętrzny identyfikator użytkownika
|
user.userId | string | |
|
Przesłane przez: Typ dostawcy
|
user.providerType | string | |
|
Przesłane przez: identyfikator użytkownika nadzorcy
|
user.supervisor.providerUserId | string | |
|
Przesłane przez: Imię nadzorcy
|
user.supervisor.fullName | string | |
|
Przesłane przez: Adres e-mail nadzorcy
|
user.supervisor.email | string | |
|
Urządzenie: typ (CORDOVA, BROWSER, PWA)
|
device.type | string | |
|
Urządzenie: wersja cordova
|
device.cordova | string | |
|
Urządzenie: model
|
device.model | string | |
|
Urządzenie: platforma
|
device.platform | string | |
|
Urządzenie: uniwersalny unikatowy identyfikator
|
device.uuid | string | |
|
Urządzenie: wersja systemu operacyjnego
|
device.version | string | |
|
Urządzenie: producent
|
device.manufacturer | string | |
|
Urządzenie: czy był symulatorem
|
device.isVirtual | boolean | |
|
Urządzenie: numer seryjny sprzętu
|
device.serial | string | |
|
Urządzenie: kod przeglądarki
|
device.appCodeName | string | |
|
Urządzenie: nazwa przeglądarki
|
device.appName | string | |
|
Urządzenie: wersja przeglądarki
|
device.appVersion | string | |
|
Urządzenie: czy włączono pliki cookie
|
device.cookieEnabled | boolean | |
|
Urządzenie: współbieżność sprzętowa
|
device.hardwareConcurrency | number | |
|
Urządzenie: preferowany język
|
device.language | string | |
|
Urządzenie: maksymalna obsługiwana liczba punktów dotykowych
|
device.maxTouchPoints | number | |
|
Urządzenie: agent użytkownika
|
device.userAgent | string | |
|
Urządzenie: dostawca przeglądarki
|
device.vendor | string | |
|
Urządzenie: wersja dostawcy przeglądarki
|
device.vendorSub | string | |
|
Urządzenie: zostało kontrolowane przez automatyzację
|
device.webdriver | boolean |
FormSubmissionPaymentCPPay
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
paymentTransaction
|
paymentTransaction | CPPayTransactionDetailsViewModelResponseEnvelope |
CPPayTransactionDetailsViewModelResponseEnvelope
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Transakcja
|
result | CPPayTransactionDetailsViewModel | |
|
Czas generowania
|
timeGenerated | string |
CPPayErrorViewModel
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
komunikat
|
message | string | |
|
: Kod błędu
|
code | CPPayErrorCodeEnum |
CPPayTransactionDetailsViewModel
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
:Typ
|
type | CPPayTransactionTypeEnum | |
|
:Id
|
id | string | |
|
:Stan
|
state | CPPayTransactionStateEnum | |
|
: Kod kupca
|
merchantCode | string | |
|
: Forma płatności
|
paymentMethodType | CPPayPaymentMethodTypeEnum | |
|
: Karta kredytowa: ostatnie 4 cyfry
|
lastFour | string | |
|
: Karta kredytowa: miesiąc wygaśnięcia
|
expMonth | integer | |
|
: Karta kredytowa: rok wygaśnięcia
|
expYear | integer | |
|
: Typ płatności
|
paymentType | CPPayPaymentTypeEnum | |
|
:Kwota
|
amount | double | |
|
: Kod błędu
|
errorCode | CPPayErrorCodeEnum | |
|
: Potwierdzenie klienta
|
customerReceipt | string | |
|
: Potwierdzenie kupców
|
merchantReceipt | string | |
|
: Format podpisu
|
customerSignatureFormat | CPPaySignatureFormatEnum | |
|
: Podpis klienta
|
customerSignature | string | |
|
: Data utworzenia
|
createdOnUtc | string | |
|
: Data ostatniej aktualizacji
|
lastModifiedOnUtc | string |
CPPayTransactionTypeEnum
- :Typ
- string
CPPayTransactionStateEnum
- :Stan
- string
CPPayPaymentMethodTypeEnum
- : Forma płatności
- string
CPPaymentTypeEnum
- : Typ płatności
- string
CPPayResponseTypeEnum
CPPayErrorCodeEnum
- : Kod błędu
- string
CPPaySignatureFormatEnum
- : Format podpisu
- string
binarny
Jest to podstawowy typ danych "binary".