Transformação do CivicPlus
Capacita os usuários empresariais a criar e implantar formulários digitais para organizações empresariais e governamentais como aplicativos web e nativos, permitindo que os desenvolvedores personalizem, estendam ou aproveitem os formulários por meio de seus próprios aplicativos personalizados. Conecte seus formulários com esse conector para permitir o envio fácil de seus dados de formulário em seus sistemas de back-end ou bancos de dados sem a necessidade de escrever código de integração complexo.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do CivicPlus |
| URL | https://www.civicoptimize.civicplus.help/hc/en-us |
| support@civicplus.com |
| Metadados do conector | |
|---|---|
| Publicador | OneBlink |
| Site | http://oneblink.io/ |
| Política de privacidade | http://oneblink.io/legal/privacy-policy |
| Categorias | Produtividade; Dados |
Conector de Transformação do CivicPlus
Capacita os usuários empresariais a criar e implantar formulários digitais para organizações empresariais e governamentais como aplicativos web e nativos, permitindo que os desenvolvedores personalizem, estendam ou aproveitem os formulários por meio de seus próprios aplicativos personalizados. Conecte seus formulários com esse conector para permitir o envio fácil de seus dados de formulário em seus sistemas de back-end ou bancos de dados sem a necessidade de escrever código de integração complexo.
Pré-requisitos
- Você precisará fazer logon no CivicPlus Transform Productivity Suite usando seu endereço de email.
- Navegue até a
Developer Keysseção do console e crie uma nova chave de API com aFormspermissão ativada.
Documentation
Para obter mais informações sobre como configurar nosso conector, consulte nosso artigo de suporte aqui.
Operações com suporte
O conector dá suporte às seguintes operações:
FormSubmissionMetaWebhookTrigger: cria um meta webhook de envio de formulário do CivicPlus
Retorna:
| Nome | Caminho | Tipo |
|---|---|---|
| ID de Formulário | formId | inteiro |
| ID de envio | ID de submissão | cadeia |
GetFormSubmissionData: permite que os dados de envio de formulário do CivicPlus sejam recuperados
Parâmetros:
| Nome | Key | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ID de Formulário | formId | true | inteiro | ID do formulário que está sendo recuperado |
| ID de envio | ID de submissão | true | cadeia | ID do envio do formulário que está sendo recuperado |
GetFormSubmissionAttachment: recupera anexos associados a um envio de formulário do CivicPlus
Parâmetros:
| Nome | Key | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ID de Formulário | formId | true | inteiro | ID do formulário com o qual o anexo foi carregado |
| ID do anexo | attachmentId | true | cadeia | ID do anexo carregado |
GenerateFormSubmissionPDF: permite que o PDF de envio de formulário seja gerado
Parâmetros:
| Nome | Key | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ID de Formulário | formId | true | inteiro | ID do formulário que foi enviado |
| ID de envio | ID de submissão | true | cadeia | ID do envio do formulário |
| Incluir id de envio em PDF | includeSubmissionIdInPdf | true | boolean | O identificador de envio pode ser incluído na parte inferior de cada página no PDF |
Instruções de implementação
Use estas instruções para implantar esse conector como conector personalizado no Microsoft Power Automate e no Power Apps.
Suporte adicional
Para obter mais apoio, você pode entrar em contato conosco support@civicplus.com em - estamos sempre felizes em ajudar.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Gerar PDF de envio de formulário |
Permite que o PDF de Envio de Formulário seja gerado |
|
Obter pagamento do Civic |
Permite que um Pagamento do CivicPlus seja recuperado |
| Recuperar anexo de envio de formulário |
Permite que os anexos de Envio de Formulário sejam recuperados |
| Recuperar dados de envio de formulário |
Permite que os dados de Envio de Formulário sejam recuperados |
| Recuperar registro de aprovação |
Permite que os dados de Aprovação de Formulário para uma única etapa sejam recuperados |
Gerar PDF de envio de formulário
Permite que o PDF de Envio de Formulário seja gerado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Formulário
|
formId | True | integer |
ID do formulário que foi enviado |
|
ID de envio
|
submissionId | True | string |
ID do envio do formulário |
|
Incluir identificador de envio em PDF
|
includeSubmissionIdInPdf | boolean |
O identificador de envio pode ser incluído na parte inferior de cada página no PDF |
|
|
Incluir detalhes de pagamento em PDF
|
includePaymentInPdf | boolean |
Os detalhes do pagamento podem ser incluídos como a página final no PDF |
|
|
Quebra de página em páginas de formulário
|
usePagesAsBreaks | boolean |
As páginas de formulário podem ser traduzidas para quebras de página no PDF |
|
|
Elementos de formulário excluídos
|
excludedElementIds | array of string |
Os identificadores dos elementos de formulário a serem excluídos do PDF |
|
|
Incluir detalhes de aprovação em PDF
|
value | string | ||
|
Tamanho da página PDF
|
pdfSize | string |
Retornos
Conteúdo do arquivo de saída do Serviço PDF
- Conteúdo PDF do Envio de Formulários
- binary
Obter pagamento do CivicPlus
Permite que um Pagamento do CivicPlus seja recuperado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de envio
|
submissionId | True | string |
ID do envio do formulário |
Retornos
Recuperar anexo de envio de formulário
Permite que os anexos de Envio de Formulário sejam recuperados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Formulário
|
formId | True | integer |
ID do formulário com o qual o anexo foi carregado |
|
ID do anexo
|
attachmentId | True | string |
ID do anexo carregado |
Retornos
Conteúdo do arquivo de saída do anexo do formulário
- Conteúdo do Anexo
- binary
Recuperar dados de envio de formulário
Permite que os dados de Envio de Formulário sejam recuperados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Formulário
|
formId | True | integer |
ID do formulário que está sendo recuperado |
|
ID de envio
|
submissionId | True | string |
ID do envio do formulário que está sendo recuperado |
Retornos
- Corpo
- FormSubmissionData
Recuperar registro de aprovação
Permite que os dados de Aprovação de Formulário para uma única etapa sejam recuperados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de envio
|
submissionId | True | string |
ID do envio do formulário |
|
Formulário
|
formId | True | integer |
Formulário para selecionar uma etapa de aprovação |
|
Etapa de aprovação
|
approvalLabel | True | string |
Etapa de aprovação para recuperar o registro de aprovação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Aprovado por: Endereço de Email
|
formSubmissionApproval.updatedBy | date-time | |
|
Carimbo de data/hora aprovado
|
formSubmissionApproval.updatedAt | date-time | |
|
ID do formulário de aprovação
|
formSubmissionApproval.approvalFormId | number | |
|
ID de envio do formulário de aprovação
|
formSubmissionApproval.approvalFormSubmissionId | string |
Gatilhos
| Dispara quando ocorre um envio de formulário |
Cria um meta-webhook de envio de formulário |
Dispara quando ocorre um envio de formulário
Cria um meta-webhook de envio de formulário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Etiqueta
|
label | string |
Rótulo a ser exibido no CivicOptimize Productivity para identificar o Evento de Fluxo de Trabalho |
|
|
Formulário
|
formId | number |
Selecione um formulário para restringir esse fluxo aos envios de um único formulário |
|
|
Trigger
|
trigger | string |
Selecione quando esse gatilho ocorrerá |
Retornos
Definições
FormSubmissionMetaWebhookPush
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de Formulário
|
formId | integer | |
|
ID de envio
|
submissionId | string | |
|
ID externa
|
externalId | string | |
|
ID do aplicativo
|
formsAppId | integer |
FormSubmissionData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do Formulário
|
definition.name | string | |
|
Descrição do formulário
|
definition.description | string | |
|
Dados de envio
|
submission | object | |
|
Enviado por: Endereço IP
|
ipAddress | string | |
|
Carimbo de data/hora de envio
|
submissionTimestamp | date-time | |
|
Enviado por: ID do usuário
|
user.providerUserId | string | |
|
Enviado por: Nome
|
user.firstName | string | |
|
Enviado por: Sobrenome
|
user.lastName | string | |
|
Enviado por: Nome Completo
|
user.fullName | string | |
|
Enviado por: Endereço de Email
|
user.email | string | |
|
Enviado por: URL da imagem
|
user.picture | string | |
|
Enviado por: Função
|
user.role | string | |
|
Enviado por: ID de usuário interna
|
user.userId | string | |
|
Enviado por: Tipo de Provedor
|
user.providerType | string | |
|
Enviado por: ID do usuário supervisor
|
user.supervisor.providerUserId | string | |
|
Enviado por: Nome Completo do Supervisor
|
user.supervisor.fullName | string | |
|
Enviado por: Endereço de Email do Supervisor
|
user.supervisor.email | string | |
|
Dispositivo: Tipo (CORDOVA, BROWSER, PWA)
|
device.type | string | |
|
Dispositivo: Versão do Cordova
|
device.cordova | string | |
|
Dispositivo: Modelo
|
device.model | string | |
|
Dispositivo: Plataforma
|
device.platform | string | |
|
Dispositivo: Identificador Universalmente Exclusivo
|
device.uuid | string | |
|
Dispositivo: Versão do sistema operacional
|
device.version | string | |
|
Dispositivo: Fabricante
|
device.manufacturer | string | |
|
Dispositivo: era um simulador
|
device.isVirtual | boolean | |
|
Dispositivo: Número de Série de Hardware
|
device.serial | string | |
|
Dispositivo: Código do navegador
|
device.appCodeName | string | |
|
Dispositivo: Nome do navegador
|
device.appName | string | |
|
Dispositivo: Versão do navegador
|
device.appVersion | string | |
|
Dispositivo: os cookies estavam habilitados
|
device.cookieEnabled | boolean | |
|
Dispositivo: Simultaneidade de Hardware
|
device.hardwareConcurrency | number | |
|
Dispositivo: Idioma Preferencial
|
device.language | string | |
|
Dispositivo: Máximo de pontos de toque com suporte
|
device.maxTouchPoints | number | |
|
Dispositivo: Agente do Usuário
|
device.userAgent | string | |
|
Dispositivo: Fornecedor do Navegador
|
device.vendor | string | |
|
Dispositivo: Versão do fornecedor do navegador
|
device.vendorSub | string | |
|
Dispositivo: foi controlado pela automação
|
device.webdriver | boolean |
FormSubmissionPaymentCPPay
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
paymentTransaction
|
paymentTransaction | CPPayTransactionDetailsViewModelResponseEnvelope |
CPPayTransactionDetailsViewModelResponseEnvelope
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Transação
|
result | CPPayTransactionDetailsViewModel | |
|
Hora da geração
|
timeGenerated | string |
CPPayErrorViewModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mensagem
|
message | string | |
|
: código de erro
|
code | CPPayErrorCodeEnum |
CPPayTransactionDetailsViewModel
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
:Tipo
|
type | CPPayTransactionTypeEnum | |
|
:Id
|
id | string | |
|
:Estado
|
state | CPPayTransactionStateEnum | |
|
: Código do Comerciante
|
merchantCode | string | |
|
: Método de Pagamento
|
paymentMethodType | CPPayPaymentMethodTypeEnum | |
|
: Cartão de Crédito: Últimos 4 Dígitos
|
lastFour | string | |
|
: Cartão de Crédito : Mês de Expiração
|
expMonth | integer | |
|
: Cartão de Crédito : Ano de Expiração
|
expYear | integer | |
|
: tipo de pagamento
|
paymentType | CPPayPaymentTypeEnum | |
|
:Quantidade
|
amount | double | |
|
: código de erro
|
errorCode | CPPayErrorCodeEnum | |
|
: Recibo do Cliente
|
customerReceipt | string | |
|
: Recibo do Comerciante
|
merchantReceipt | string | |
|
: Formato de assinatura
|
customerSignatureFormat | CPPaySignatureFormatEnum | |
|
: Assinatura do Cliente
|
customerSignature | string | |
|
: Data de Criação
|
createdOnUtc | string | |
|
: Data da Última Atualização
|
lastModifiedOnUtc | string |
CPPayTransactionTypeEnum
- :Tipo
- string
CPPayTransactionStateEnum
- :Estado
- string
CPPayPaymentMethodTypeEnum
- : Método de Pagamento
- string
CPPayPaymentTypeEnum
- : tipo de pagamento
- string
CPPayResponseTypeEnum
CPPayErrorCodeEnum
- : código de erro
- string
CPPaySignatureFormatEnum
- : Formato de assinatura
- string
binário
Esse é o tipo de dados básico 'binary'.