diff --git a/ClickFlow_Orchestrator_Insomnia_Collection.json b/ClickFlow_Orchestrator_Insomnia_Collection.json new file mode 100644 index 0000000..bc60569 --- /dev/null +++ b/ClickFlow_Orchestrator_Insomnia_Collection.json @@ -0,0 +1,1407 @@ +{ + "_type": "export", + "__export_format": 4, + "__export_date": "2026-09-15T20:46:04.521Z", + "__export_source": "generate-collections.js", + "resources": [ + { + "_type": "workspace", + "_id": "wrk_66fd35b398bd40e69d7baf4ad45918e6", + "name": "ClickFlow Orchestrator", + "description": "", + "scope": "collection" + }, + { + "_type": "environment", + "_id": "env_3fb250e5ce1449389721e58f4857501b", + "parentId": "wrk_66fd35b398bd40e69d7baf4ad45918e6", + "name": "Base Environment", + "data": {}, + "dataPropertyOrder": null, + "color": null, + "isPrivate": false, + "metaSortKey": 1000000000000 + }, + { + "_type": "environment", + "_id": "env_077bcaf3afca490091388994cebc8d15", + "parentId": "env_3fb250e5ce1449389721e58f4857501b", + "name": "Sandbox", + "data": { + "host": "clickflow-sandbox.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#7d69cb", + "isPrivate": false, + "metaSortKey": 1000000001000 + }, + { + "_type": "environment", + "_id": "env_c30f9c0455814ca9aa5294559e0bee66", + "parentId": "env_3fb250e5ce1449389721e58f4857501b", + "name": "Produção", + "data": { + "host": "clickflow.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#d9534f", + "isPrivate": false, + "metaSortKey": 1000000002000 + }, + { + "_type": "request_group", + "_id": "fld_f3e1077c0ff54b1197a5d88dca188f3d", + "parentId": "wrk_66fd35b398bd40e69d7baf4ad45918e6", + "name": "Health", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000000 + }, + { + "_type": "request", + "_id": "req_d332c1f9cba14e898f82cd47572fc76b", + "parentId": "fld_f3e1077c0ff54b1197a5d88dca188f3d", + "name": "Health check", + "description": "", + "url": "https://{{host}}/health", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + } + ], + "authentication": {}, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_4487efbdf1564523a0e8b4105650fb48", + "parentId": "wrk_66fd35b398bd40e69d7baf4ad45918e6", + "name": "Executions", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000001 + }, + { + "_type": "request", + "_id": "req_0f493402a8004a8a9b7b0c0aefa1af71", + "parentId": "fld_4487efbdf1564523a0e8b4105650fb48", + "name": "Estado da execução", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_45daada6da7d4a44a505f9b6ca9c1fd4", + "parentId": "fld_4487efbdf1564523a0e8b4105650fb48", + "name": "Cancela uma execução em andamento", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}/cancel", + "method": "POST", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_91e1f74b1c564d578e36163b528bd610", + "parentId": "fld_4487efbdf1564523a0e8b4105650fb48", + "name": "Avança para o próximo passo", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}/next", + "method": "POST", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8b74ad82e218485e8c1bc24ebf63c80c", + "parentId": "fld_4487efbdf1564523a0e8b4105650fb48", + "name": "Lista execuções de um flow", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/executions", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_96e04e188b7349e1907003ca1cdfe7a5", + "parentId": "fld_4487efbdf1564523a0e8b4105650fb48", + "name": "Inicia execução de um flow publicado", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/executions", + "method": "POST", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_3a1f14b560f546f0b9295f446ae825b5", + "parentId": "wrk_66fd35b398bd40e69d7baf4ad45918e6", + "name": "Flows", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000002 + }, + { + "_type": "request", + "_id": "req_f994c205601e4a659cc3129649f9dae5", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Lista flows", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_0981d0e3c6aa4732ab67138b22734c7b", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Cria flow", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — acceptance\",\n \"steps\": [\n {\n \"context\": {\n \"accept_replies\": [\n \"accept\",\n \"aceitar\"\n ],\n \"template_key\": \"chave-do-template\"\n },\n \"type\": \"acceptance\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_79f5ec4f809944359d697fb193de421c", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Obtém flow por ID", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_84cfd82f99c1445ea0253820f2ed4ed3", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Atualiza flow", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}", + "method": "PUT", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — acceptance\",\n \"steps\": [\n {\n \"context\": {\n \"accept_replies\": [\n \"accept\",\n \"aceitar\"\n ],\n \"template_key\": \"chave-do-template\"\n },\n \"type\": \"acceptance\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_6f8e164931c34f46aa2d2ddb0fb1ca92", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Remove flow", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}", + "method": "DELETE", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_a9837b87c85048b4a58a1ce4538f38a6", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Publica flow (draft ou unpublished → published)", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/publish", + "method": "PATCH", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000005, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_9a7b6e0cb0354f5d92c198a48a9f2eb6", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Despublica flow (published → unpublished)", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/unpublish", + "method": "PATCH", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000006, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_3a6a06bd110a43dcb95296c0942734a6", + "parentId": "fld_3a1f14b560f546f0b9295f446ae825b5", + "name": "Exemplos de Flows", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000003 + }, + { + "_type": "request", + "_id": "req_7aaddd5345af4e8993876e54b215338f", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Consent", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — consent\",\n \"steps\": [\n {\n \"context\": {\n \"channel_type\": \"whatsapp\",\n \"template_id\": \"seu-template-id\"\n },\n \"type\": \"consent\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_b84ef8b9256d41a78dd4ed3d190eecff", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Consent — variáveis por step (channel_params)", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — consent com variáveis\",\n \"steps\": [\n {\n \"context\": {\n \"channel_params\": {\n \"steps\": [\n {\n \"step_id\": \"apresentacao\",\n \"variables\": {\n \"body\": [\n \"{{person_name}}\",\n \"Carro Azul\",\n \"{{cpf_form_field}}\"\n ],\n \"header\": []\n }\n }\n ]\n },\n \"channel_type\": \"whatsapp\",\n \"template_id\": \"seu-template-id\"\n },\n \"type\": \"consent\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_7dc48107d6bc4503b0e0d2db3d4b37d5", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Form", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — form\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_61bfa1079f034d2ba8f125d7d5170481", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Form — atualização de contato", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — form com atualização de contato\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_0f8f4ed60ca14a278bd85dedb2e58e89", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Form — Injeção de respostas de formulários anteriores", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Injeção de respostas de formulários anteriores\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"versao-formulario-cadastro\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"context_map_keys\": {\n \"campo-destino-formulario-atual\": {\n \"read_only\": false,\n \"value\": \"campo-origem\"\n },\n \"email-confirmacao\": {\n \"read_only\": true,\n \"value\": \"email-cadastro\"\n },\n \"nome-completo-confirmacao\": {\n \"read_only\": false,\n \"value\": \"nome-completo-cadastro\"\n },\n \"whatsapp-confirmacao\": {\n \"read_only\": true,\n \"value\": \"whatsapp-cadastro\"\n }\n },\n \"version_key\": \"versao-formulario-confirmacao\"\n },\n \"type\": \"form\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_d4423a982d64411fbcc4e61a63e08051", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Form — Injeção do contato no formulário", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Injeção do contato no formulário\",\n \"steps\": [\n {\n \"context\": {\n \"context_map_keys\": {\n \"cpf\": {\n \"read_only\": true,\n \"value\": \"{{person_documentation}}\"\n },\n \"data-nascimento\": {\n \"read_only\": true,\n \"value\": \"{{person_birthday}}\"\n },\n \"nome-completo\": {\n \"read_only\": true,\n \"value\": \"{{person_name}}\"\n },\n \"whatsapp\": {\n \"read_only\": true,\n \"value\": \"{{phone_number}}\"\n }\n },\n \"version_key\": \"versao-formulario-confirmacao\"\n },\n \"type\": \"form\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000005, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_46ffe53d5429418483de41a50d008062", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "KYC — biometric_behavior + kyc (CNPJ)", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior + kyc (CNPJ)\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"result_policy\": \"passthrough\"\n },\n \"type\": \"verify\"\n },\n {\n \"context\": {\n \"type\": \"business\"\n },\n \"type\": \"kyc\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000006, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8e461d417fe04a9e94ee15b4652ba62d", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "KYC — form + biometric_behavior + kyc (CPF)", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — form + verify biometric_behavior + kyc (CPF)\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"contact_fields_map\": {\n \"person_documentation\": \"field-key-do-documento\",\n \"person_name\": \"field-key-do-nome\"\n },\n \"result_policy\": \"passthrough\"\n },\n \"type\": \"verify\"\n },\n {\n \"context\": {\n \"type\": \"customer\"\n },\n \"type\": \"kyc\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000007, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_815912471ab142968ae691279a2cf123", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — template + configurações do envelope", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — assinatura com configurações do envelope\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"{{person_name}}_settings.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"auto_close\": false,\n \"block_after_refusal\": false,\n \"deadline_at\": 30,\n \"default_message\": \"Documento referente a {{data-contrato-d0349c5e8e90}}.\",\n \"default_subject\": \"Assine seu documento, {{person_name}}\",\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"locale\": \"en-US\",\n \"name\": \"Envelope {{person_name}} — {{data-contrato-d0349c5e8e90}}\",\n \"remind_interval\": \"2\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000008, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_f74b3774fe074d3c8200cddf9aae9dde", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — arquivo S3", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato-proposta.pdf\",\n \"kind\": \"file\",\n \"s3_bucket\": \"meu-bucket\",\n \"s3_key\": \"caminho/para/contrato.pdf\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000009, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_ff28703172d94ecba1f894ab4613f9d8", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — filename com interpolação", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — form + signature com filename\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"doc_{{person_name}}_{{field-key-do-version}}.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"name\": \"Envelope {{person_name}}\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000010, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_bef92634a00b4cdf9880a41ce48e8ee2", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — arquivo S3 + modelo Tavola", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — arquivo S3 + template\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"anexo.pdf\",\n \"kind\": \"file\",\n \"s3_bucket\": \"meu-bucket\",\n \"s3_key\": \"caminho/para/anexo.pdf\"\n },\n {\n \"filename\": \"contrato.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000011, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_29469ecf71f6487384a466ca5d04cba5", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — runner_files", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — runner_files\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato.pdf\",\n \"key\": \"1\",\n \"kind\": \"runner_files\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000012, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_a878e80de10e44d18a99c0b0f863b5f3", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — template + signatários extras", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — assinatura com signatários extras\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"{{person_name}}.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"name\": \"Envelope {{person_name}}\"\n },\n \"signers\": [\n {\n \"auths\": [\n \"handwritten\"\n ],\n \"birthday\": \"2021-07-15\",\n \"communicate_events\": {\n \"document_signed\": \"email\",\n \"signature_reminder\": \"email\",\n \"signature_request\": \"email\"\n },\n \"documentation\": \"34623794024\",\n \"email\": \"signatario.fixo@mail.com\",\n \"group\": 1,\n \"has_documentation\": true,\n \"location_required_enabled\": true,\n \"name\": \"Signatário Fixo\",\n \"phone_number\": \"49999999999\",\n \"refusable\": false,\n \"roles\": [\n \"witness\"\n ]\n },\n {\n \"auths\": [\n \"liveness\",\n \"whatsapp\"\n ],\n \"birthday\": \"{{person_birthday}}\",\n \"documentation\": \"{{person_documentation}}\",\n \"group\": 2,\n \"name\": \"{{person_name}}\",\n \"phone_number\": \"{{phone_number}}\",\n \"roles\": [\n \"sign\"\n ]\n }\n ]\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000013, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_28eb1cc096c845bfa71bb627352868ac", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Signature — modelo Tavola", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — template\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato-proposta.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000014, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_dcb55317d5894f8d858ff5b7238704f1", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — liveness", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\"\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000015, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_fa9469c9049445c2a743a1554eeac2f0", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — biometric_behavior", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\"\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000016, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_65388c603cc443e08a93968b8d147a12", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — biometric_behavior + form", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior + form\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"contact_fields_map\": {\n \"person_documentation\": \"field-key-do-documento\",\n \"person_name\": \"field-key-do-nome\"\n }\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000017, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_d41f17a3c8b7451abec0d1357919be66", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — identity_biometrics", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify identity_biometrics\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"identity_biometrics\"\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000018, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_a839e107747f41bab0bc6235f4236e0b", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — instructions", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify instructions\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\",\n \"instructions\": true\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000019, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_c4b7888b0f9a416fa7df2bb5c9906af9", + "parentId": "fld_3a6a06bd110a43dcb95296c0942734a6", + "name": "Verify — provider_priority", + "description": "", + "url": "https://{{host}}/api/v1/flows", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Proposta Crédito — verify provider_priority\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\",\n \"provider_priority\": [\n \"caf\",\n \"clearsale\"\n ]\n },\n \"type\": \"verify\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000020, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + } + ] +} \ No newline at end of file diff --git a/ClickFlow_Orchestrator_Postman_Collection.json b/ClickFlow_Orchestrator_Postman_Collection.json new file mode 100644 index 0000000..5800d6b --- /dev/null +++ b/ClickFlow_Orchestrator_Postman_Collection.json @@ -0,0 +1,1988 @@ +{ + "info": { + "_postman_id": "05026e7b-a3a0-4a8e-a400-269c13daef81", + "name": "ClickFlow Orchestrator", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "host", + "value": "clickflow-sandbox.clicksign.com" + } + ], + "item": [ + { + "name": "Health", + "item": [ + { + "name": "Health check", + "request": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/health", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "health" + ] + }, + "auth": { + "type": "noauth" + } + }, + "response": [] + } + ] + }, + { + "name": "Executions", + "item": [ + { + "name": "Estado da execução", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cancela uma execução em andamento", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}/cancel", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}", + "cancel" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Avança para o próximo passo", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}/next", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}", + "next" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Lista execuções de um flow", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/executions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "executions" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Inicia execução de um flow publicado", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/executions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "executions" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Flows", + "item": [ + { + "name": "Lista flows", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cria flow", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — acceptance\",\n \"steps\": [\n {\n \"context\": {\n \"accept_replies\": [\n \"accept\",\n \"aceitar\"\n ],\n \"template_key\": \"chave-do-template\"\n },\n \"type\": \"acceptance\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Obtém flow por ID", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Atualiza flow", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — acceptance\",\n \"steps\": [\n {\n \"context\": {\n \"accept_replies\": [\n \"accept\",\n \"aceitar\"\n ],\n \"template_key\": \"chave-do-template\"\n },\n \"type\": \"acceptance\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Remove flow", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Publica flow (draft ou unpublished → published)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/publish", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "publish" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Despublica flow (published → unpublished)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/unpublish", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "unpublish" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Exemplos de Flows", + "item": [ + { + "name": "Consent", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — consent\",\n \"steps\": [\n {\n \"context\": {\n \"channel_type\": \"whatsapp\",\n \"template_id\": \"seu-template-id\"\n },\n \"type\": \"consent\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Consent — variáveis por step (channel_params)", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — consent com variáveis\",\n \"steps\": [\n {\n \"context\": {\n \"channel_params\": {\n \"steps\": [\n {\n \"step_id\": \"apresentacao\",\n \"variables\": {\n \"body\": [\n \"{{person_name}}\",\n \"Carro Azul\",\n \"{{cpf_form_field}}\"\n ],\n \"header\": []\n }\n }\n ]\n },\n \"channel_type\": \"whatsapp\",\n \"template_id\": \"seu-template-id\"\n },\n \"type\": \"consent\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Form", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — form\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Form — atualização de contato", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — form com atualização de contato\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Form — Injeção de respostas de formulários anteriores", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Injeção de respostas de formulários anteriores\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"versao-formulario-cadastro\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"context_map_keys\": {\n \"campo-destino-formulario-atual\": {\n \"read_only\": false,\n \"value\": \"campo-origem\"\n },\n \"email-confirmacao\": {\n \"read_only\": true,\n \"value\": \"email-cadastro\"\n },\n \"nome-completo-confirmacao\": {\n \"read_only\": false,\n \"value\": \"nome-completo-cadastro\"\n },\n \"whatsapp-confirmacao\": {\n \"read_only\": true,\n \"value\": \"whatsapp-cadastro\"\n }\n },\n \"version_key\": \"versao-formulario-confirmacao\"\n },\n \"type\": \"form\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Form — Injeção do contato no formulário", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Injeção do contato no formulário\",\n \"steps\": [\n {\n \"context\": {\n \"context_map_keys\": {\n \"cpf\": {\n \"read_only\": true,\n \"value\": \"{{person_documentation}}\"\n },\n \"data-nascimento\": {\n \"read_only\": true,\n \"value\": \"{{person_birthday}}\"\n },\n \"nome-completo\": {\n \"read_only\": true,\n \"value\": \"{{person_name}}\"\n },\n \"whatsapp\": {\n \"read_only\": true,\n \"value\": \"{{phone_number}}\"\n }\n },\n \"version_key\": \"versao-formulario-confirmacao\"\n },\n \"type\": \"form\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "KYC — biometric_behavior + kyc (CNPJ)", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior + kyc (CNPJ)\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"result_policy\": \"passthrough\"\n },\n \"type\": \"verify\"\n },\n {\n \"context\": {\n \"type\": \"business\"\n },\n \"type\": \"kyc\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "KYC — form + biometric_behavior + kyc (CPF)", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — form + verify biometric_behavior + kyc (CPF)\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"contact_fields_map\": {\n \"person_documentation\": \"field-key-do-documento\",\n \"person_name\": \"field-key-do-nome\"\n },\n \"result_policy\": \"passthrough\"\n },\n \"type\": \"verify\"\n },\n {\n \"context\": {\n \"type\": \"customer\"\n },\n \"type\": \"kyc\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — template + configurações do envelope", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — assinatura com configurações do envelope\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"{{person_name}}_settings.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"auto_close\": false,\n \"block_after_refusal\": false,\n \"deadline_at\": 30,\n \"default_message\": \"Documento referente a {{data-contrato-d0349c5e8e90}}.\",\n \"default_subject\": \"Assine seu documento, {{person_name}}\",\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"locale\": \"en-US\",\n \"name\": \"Envelope {{person_name}} — {{data-contrato-d0349c5e8e90}}\",\n \"remind_interval\": \"2\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — arquivo S3", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato-proposta.pdf\",\n \"kind\": \"file\",\n \"s3_bucket\": \"meu-bucket\",\n \"s3_key\": \"caminho/para/contrato.pdf\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — filename com interpolação", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — form + signature com filename\",\n \"steps\": [\n {\n \"context\": {\n \"contact\": {\n \"person_birthday\": \"person-birthday-b8f2a1c3d4e5\",\n \"person_documentation\": \"person-documentation-d0349c5e8e90\",\n \"person_name\": \"person-name-4e578ecaa76c\",\n \"phone_number\": \"phone-number-3d172314e41b\"\n },\n \"version_key\": \"a0cfcec8-4d18-49a8-b6d1-85df293d5cb4\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"doc_{{person_name}}_{{field-key-do-version}}.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"name\": \"Envelope {{person_name}}\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — arquivo S3 + modelo Tavola", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — arquivo S3 + template\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"anexo.pdf\",\n \"kind\": \"file\",\n \"s3_bucket\": \"meu-bucket\",\n \"s3_key\": \"caminho/para/anexo.pdf\"\n },\n {\n \"filename\": \"contrato.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — runner_files", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — runner_files\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato.pdf\",\n \"key\": \"1\",\n \"kind\": \"runner_files\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — template + signatários extras", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — assinatura com signatários extras\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"{{person_name}}.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\",\n \"name\": \"Envelope {{person_name}}\"\n },\n \"signers\": [\n {\n \"auths\": [\n \"handwritten\"\n ],\n \"birthday\": \"2021-07-15\",\n \"communicate_events\": {\n \"document_signed\": \"email\",\n \"signature_reminder\": \"email\",\n \"signature_request\": \"email\"\n },\n \"documentation\": \"34623794024\",\n \"email\": \"signatario.fixo@mail.com\",\n \"group\": 1,\n \"has_documentation\": true,\n \"location_required_enabled\": true,\n \"name\": \"Signatário Fixo\",\n \"phone_number\": \"49999999999\",\n \"refusable\": false,\n \"roles\": [\n \"witness\"\n ]\n },\n {\n \"auths\": [\n \"liveness\",\n \"whatsapp\"\n ],\n \"birthday\": \"{{person_birthday}}\",\n \"documentation\": \"{{person_documentation}}\",\n \"group\": 2,\n \"name\": \"{{person_name}}\",\n \"phone_number\": \"{{phone_number}}\",\n \"roles\": [\n \"sign\"\n ]\n }\n ]\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Signature — modelo Tavola", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — template\",\n \"steps\": [\n {\n \"context\": {\n \"documents\": [\n {\n \"filename\": \"contrato-proposta.docx\",\n \"kind\": \"template\",\n \"template_key\": \"uuid-do-modelo-tavola\"\n }\n ],\n \"settings\": {\n \"folder_key\": \"1fb29ab8-84c4-4856-be37-5fce0f17c11a\"\n }\n },\n \"type\": \"signature\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — liveness", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\"\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — biometric_behavior", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\"\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — biometric_behavior + form", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify biometric_behavior + form\",\n \"steps\": [\n {\n \"context\": {\n \"version_key\": \"sua-form-version-key\"\n },\n \"type\": \"form\"\n },\n {\n \"context\": {\n \"authentication\": \"biometric_behavior\",\n \"contact_fields_map\": {\n \"person_documentation\": \"field-key-do-documento\",\n \"person_name\": \"field-key-do-nome\"\n }\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — identity_biometrics", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify identity_biometrics\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"identity_biometrics\"\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — instructions", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify instructions\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\",\n \"instructions\": true\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Verify — provider_priority", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Proposta Crédito — verify provider_priority\",\n \"steps\": [\n {\n \"context\": {\n \"authentication\": \"liveness\",\n \"provider_priority\": [\n \"caf\",\n \"clearsale\"\n ]\n },\n \"type\": \"verify\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/ClickFlow_Orchestrator_Postman_Environment.json b/ClickFlow_Orchestrator_Postman_Environment.json new file mode 100644 index 0000000..71b36dd --- /dev/null +++ b/ClickFlow_Orchestrator_Postman_Environment.json @@ -0,0 +1,57 @@ +{ + "id": "b9a726cb-3018-4ed7-922a-dd2f378212e5", + "name": "ClickFlow Orchestrator - Sandbox", + "values": [ + { + "key": "host", + "value": "clickflow-sandbox.clicksign.com", + "type": "default", + "enabled": true + }, + { + "key": "host_production", + "value": "clickflow.clicksign.com", + "type": "default", + "enabled": false + }, + { + "key": "access_token", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "flow_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "execution_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "form_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "version_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "run_key", + "value": "", + "type": "default", + "enabled": true + } + ], + "_postman_variable_scope": "environment", + "_postman_exported_at": "2026-09-15T20:46:04.516Z", + "_postman_exported_using": "generate-collections.js" +} \ No newline at end of file diff --git a/ClickFlow_Runner_Insomnia_Collection.json b/ClickFlow_Runner_Insomnia_Collection.json new file mode 100644 index 0000000..bb3f802 --- /dev/null +++ b/ClickFlow_Runner_Insomnia_Collection.json @@ -0,0 +1,355 @@ +{ + "_type": "export", + "__export_format": 4, + "__export_date": "2026-09-15T20:46:04.601Z", + "__export_source": "generate-collections.js", + "resources": [ + { + "_type": "workspace", + "_id": "wrk_44107742d5d6492d8a32474c599c760f", + "name": "ClickFlow Runner", + "description": "", + "scope": "collection" + }, + { + "_type": "environment", + "_id": "env_52286a021ad94a2985e3806d669271ee", + "parentId": "wrk_44107742d5d6492d8a32474c599c760f", + "name": "Base Environment", + "data": {}, + "dataPropertyOrder": null, + "color": null, + "isPrivate": false, + "metaSortKey": 1000000000000 + }, + { + "_type": "environment", + "_id": "env_1dbb4e09182241a4be3b2d910e78c95d", + "parentId": "env_52286a021ad94a2985e3806d669271ee", + "name": "Sandbox", + "data": { + "host": "clickflow-runner-sandbox.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#7d69cb", + "isPrivate": false, + "metaSortKey": 1000000001000 + }, + { + "_type": "environment", + "_id": "env_d899fe2d3bfa4d1697cb3b2a509859f1", + "parentId": "env_52286a021ad94a2985e3806d669271ee", + "name": "Produção", + "data": { + "host": "clickflow-runner.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#d9534f", + "isPrivate": false, + "metaSortKey": 1000000002000 + }, + { + "_type": "request_group", + "_id": "fld_3df3337487024ba8b952690320e3e645", + "parentId": "wrk_44107742d5d6492d8a32474c599c760f", + "name": "Health", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000000 + }, + { + "_type": "request", + "_id": "req_be73452156204a25b2a46c5b0b886a87", + "parentId": "fld_3df3337487024ba8b952690320e3e645", + "name": "Health check", + "description": "", + "url": "https://{{host}}/health", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + } + ], + "authentication": {}, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_b81e2c3806394ca9b611106a1312e4ac", + "parentId": "wrk_44107742d5d6492d8a32474c599c760f", + "name": "Executions", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000001 + }, + { + "_type": "request", + "_id": "req_781942ad4c0e4683b5f9a811fb086a48", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Retorna uma execução", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_111b61d28951459d883216f11412c7af", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Cancela uma execução", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}/cancel", + "method": "POST", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_465404d779d04ebaa90f00c3f622035a", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Lista os steps de uma execução", + "description": "", + "url": "https://{{host}}/api/v1/executions/{{execution_id}}/steps", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_818cd5b08e4240de98f18e5ca7e6933a", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Inicia execução — WhatsApp", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n }\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_105c06ac39264a329d8f179b48bc9872", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Inicia execução — canal API", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"channel\": \"api\",\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n }\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8f3fbfc4d969438591ce9fb1efa6aa2f", + "parentId": "fld_b81e2c3806394ca9b611106a1312e4ac", + "name": "Inicia execução — com arquivo (runner_files)", + "description": "", + "url": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n },\n \"files\": [\n {\n \"key\": \"1\",\n \"content_base_64\": \"data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovUmVzb3VyY2VzIDw8Pj4KL0NvbnRlbnRzIDQgMCBSCj4+CmVuZG9iago0IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihTYW1wbGUpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1OCAwMDAwMCBuIAowMDAwMDAwMTE1IDAwMDAwIG4gCjAwMDAwMDAyMDQgMDAwMDAgbiAKMDAwMDAwMDI5MyAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDUKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM4NQolJUVPRgo=\"\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000005, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + } + ] +} \ No newline at end of file diff --git a/ClickFlow_Runner_Postman_Collection.json b/ClickFlow_Runner_Postman_Collection.json new file mode 100644 index 0000000..e838516 --- /dev/null +++ b/ClickFlow_Runner_Postman_Collection.json @@ -0,0 +1,416 @@ +{ + "info": { + "_postman_id": "8bc7f51b-ad39-4790-9d64-1c648f8fa471", + "name": "ClickFlow Runner", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "host", + "value": "clickflow-runner-sandbox.clicksign.com" + } + ], + "item": [ + { + "name": "Health", + "item": [ + { + "name": "Health check", + "request": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/health", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "health" + ] + }, + "auth": { + "type": "noauth" + } + }, + "response": [] + } + ] + }, + { + "name": "Executions", + "item": [ + { + "name": "Retorna uma execução", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cancela uma execução", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}/cancel", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}", + "cancel" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Lista os steps de uma execução", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/executions/{{execution_id}}/steps", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "executions", + "{{execution_id}}", + "steps" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Inicia execução — WhatsApp", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "execute" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Inicia execução — canal API", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "execute" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"channel\": \"api\",\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Inicia execução — com arquivo (runner_files)", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/flows/{{flow_id}}/execute", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "flows", + "{{flow_id}}", + "execute" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"contact\": {\n \"person_name\": \"Maria da Silva\",\n \"phone_number\": \"5511999999999\"\n },\n \"files\": [\n {\n \"key\": \"1\",\n \"content_base_64\": \"data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovUmVzb3VyY2VzIDw8Pj4KL0NvbnRlbnRzIDQgMCBSCj4+CmVuZG9iago0IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihTYW1wbGUpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1OCAwMDAwMCBuIAowMDAwMDAwMTE1IDAwMDAwIG4gCjAwMDAwMDAyMDQgMDAwMDAgbiAKMDAwMDAwMDI5MyAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDUKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM4NQolJUVPRgo=\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + } + ] +} \ No newline at end of file diff --git a/ClickFlow_Runner_Postman_Environment.json b/ClickFlow_Runner_Postman_Environment.json new file mode 100644 index 0000000..e0ecea0 --- /dev/null +++ b/ClickFlow_Runner_Postman_Environment.json @@ -0,0 +1,57 @@ +{ + "id": "212c7448-bc5b-4416-8222-4767c70ec0e8", + "name": "ClickFlow Runner - Sandbox", + "values": [ + { + "key": "host", + "value": "clickflow-runner-sandbox.clicksign.com", + "type": "default", + "enabled": true + }, + { + "key": "host_production", + "value": "clickflow-runner.clicksign.com", + "type": "default", + "enabled": false + }, + { + "key": "access_token", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "flow_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "execution_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "form_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "version_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "run_key", + "value": "", + "type": "default", + "enabled": true + } + ], + "_postman_variable_scope": "environment", + "_postman_exported_at": "2026-09-15T20:46:04.599Z", + "_postman_exported_using": "generate-collections.js" +} \ No newline at end of file diff --git a/ClickForm_Insomnia_Collection.json b/ClickForm_Insomnia_Collection.json new file mode 100644 index 0000000..26a20e1 --- /dev/null +++ b/ClickForm_Insomnia_Collection.json @@ -0,0 +1,1498 @@ +{ + "_type": "export", + "__export_format": 4, + "__export_date": "2026-09-15T20:46:04.655Z", + "__export_source": "generate-collections.js", + "resources": [ + { + "_type": "workspace", + "_id": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "ClickForm", + "description": "", + "scope": "collection" + }, + { + "_type": "environment", + "_id": "env_19f225be3b6d4f43be39d29f8e96a391", + "parentId": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "Base Environment", + "data": {}, + "dataPropertyOrder": null, + "color": null, + "isPrivate": false, + "metaSortKey": 1000000000000 + }, + { + "_type": "environment", + "_id": "env_bfd8292e57d749c4b8e1377f8d3c05e3", + "parentId": "env_19f225be3b6d4f43be39d29f8e96a391", + "name": "Sandbox", + "data": { + "host": "clickform-sandbox.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#7d69cb", + "isPrivate": false, + "metaSortKey": 1000000001000 + }, + { + "_type": "environment", + "_id": "env_03db797f35454837ba4dcefcdd6c7c02", + "parentId": "env_19f225be3b6d4f43be39d29f8e96a391", + "name": "Produção", + "data": { + "host": "clickform.clicksign.com", + "access_token": "", + "flow_id": "", + "execution_id": "", + "form_key": "", + "version_key": "", + "run_key": "" + }, + "dataPropertyOrder": { + "&": [ + "host", + "access_token", + "flow_id", + "execution_id", + "form_key", + "version_key", + "run_key" + ] + }, + "color": "#d9534f", + "isPrivate": false, + "metaSortKey": 1000000002000 + }, + { + "_type": "request_group", + "_id": "fld_83a4a99b58814d45a8505caee72d8148", + "parentId": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "Health", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000000 + }, + { + "_type": "request", + "_id": "req_c292c8caa5d342b7aaff1b92fef5e779", + "parentId": "fld_83a4a99b58814d45a8505caee72d8148", + "name": "Verifica disponibilidade do serviço", + "description": "", + "url": "https://{{host}}/health", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + } + ], + "authentication": {}, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_7a34e5d776fc496cba691fb61c20d50b", + "parentId": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "Forms", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000001 + }, + { + "_type": "request", + "_id": "req_981cb4b6a6564d42a1cf6ed62d4626d3", + "parentId": "fld_7a34e5d776fc496cba691fb61c20d50b", + "name": "Lista todos os formulários", + "description": "", + "url": "https://{{host}}/api/v1/forms", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_901047277d7b4668b645e8b9e36a661b", + "parentId": "fld_7a34e5d776fc496cba691fb61c20d50b", + "name": "Cria o formulário base", + "description": "", + "url": "https://{{host}}/api/v1/forms", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Cadastro de cliente\",\n \"callback_url\": \"https://partner.example.com/hooks/clickform\"\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_28802eaa60554fcd93994220eee3a41c", + "parentId": "fld_7a34e5d776fc496cba691fb61c20d50b", + "name": "Retorna metadados de um formulário específico", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8286326907144104852d21b915a4712b", + "parentId": "fld_7a34e5d776fc496cba691fb61c20d50b", + "name": "Atualiza os metadados do formulário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}", + "method": "PUT", + "body": { + "mimeType": "application/json", + "text": "{\n \"name\": \"Cadastro de cliente — revisão 2\",\n \"callback_url\": \"https://partner.example.com/hooks/clickform-v2\"\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_0de933a8fec04661bd615c48e6764733", + "parentId": "fld_7a34e5d776fc496cba691fb61c20d50b", + "name": "Remove um formulário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}", + "method": "DELETE", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_4e368de0c57b4c528af804a4434cbd4e", + "parentId": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "Runs", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000002 + }, + { + "_type": "request", + "_id": "req_cdd1d0b3feb54387a1959dec54399f18", + "parentId": "fld_4e368de0c57b4c528af804a4434cbd4e", + "name": "Lista todas as execuções associadas a uma versão", + "description": "", + "url": "https://{{host}}/api/v1/versions/{{version_key}}/runs", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8140204feb5b4fe6942e5a9beccf7e06", + "parentId": "fld_4e368de0c57b4c528af804a4434cbd4e", + "name": "Cria uma versão pré-preenchida do formulário para preenchimento único", + "description": "", + "url": "https://{{host}}/api/v1/versions/{{version_key}}/runs", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"callback_url\": \"https://erp.cliente.com/callback\",\n \"context\": {\n \"nome-completo-59661f5fe933\": {\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n \"whatsapp-f9c2322fcc74\": {\n \"value\": \"48999999999\",\n \"read_only\": false\n },\n \"email-6679641e7540\": {\n \"value\": \"john.doe@developer.com\",\n \"read_only\": true\n }\n },\n \"notification\": {\n \"whatsapp\": \"(11) 9 1234-5678\"\n }\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_d452a96e0fc440758d294fba0cea1fab", + "parentId": "fld_4e368de0c57b4c528af804a4434cbd4e", + "name": "Obtém uma execução (run) por versão", + "description": "", + "url": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_512aeb268ee947d5a4b687f8ac628403", + "parentId": "fld_4e368de0c57b4c528af804a4434cbd4e", + "name": "Atualiza contexto, expires_at ou callback_url do run", + "description": "", + "url": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "method": "PUT", + "body": { + "mimeType": "application/json", + "text": "{\n \"context\": {\n \"nome-completo-59661f5fe933\": {\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n \"whatsapp-f9c2322fcc74\": {\n \"value\": \"48999999999\",\n \"read_only\": false\n },\n \"email-6679641e7540\": {\n \"value\": \"john.doe@developer.com\",\n \"read_only\": true\n }\n },\n \"expires_at\": \"2026-12-31T23:59:59Z\",\n \"callback_url\": \"https://erp.cliente.com/callback\"\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_602c89d2d87b49bb9355e762e9141cf0", + "parentId": "fld_4e368de0c57b4c528af804a4434cbd4e", + "name": "Remove uma execução pendente", + "description": "", + "url": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "method": "DELETE", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "parentId": "wrk_32162ddf1005481ba8daef4cc91d6103", + "name": "Versions", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000003 + }, + { + "_type": "request", + "_id": "req_bd25bcbf6df040fb96d18bb4cfef44dc", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Lista todas as versões de um formulário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_7f50f71afcf04b8eb556b214021b1cd9", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Cria uma nova versão (schema) do formulário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\",\n \"steps\": {\n \"0\": \"Informações pessoais\",\n \"1\": \"Informações de contato\"\n }\n },\n \"fields\": [\n {\n \"label\": \"Nome completo\",\n \"type\": \"text\",\n \"placeholder\": \"Maria da Silva\",\n \"help_balloon\": \"Use o mesmo nome do documento.\",\n \"required\": true,\n \"step\": 0,\n \"order\": 1\n },\n {\n \"label\": \"Whatsapp\",\n \"type\": \"phone_number\",\n \"placeholder\": \"(11) 99999-9999\",\n \"help_balloon\": \"Inclua o DDD para facilitar o retorno.\",\n \"required\": true,\n \"step\": 1\n },\n {\n \"label\": \"Email\",\n \"type\": \"email\",\n \"placeholder\": \"nome@empresa.com\",\n \"help_balloon\": \"Informe um e-mail válido para contato.\",\n \"required\": true,\n \"step\": 1\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_a8e83393036544559f2913eeab62c3b8", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Retorna a estrutura da versão", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "method": "GET", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_d2c4c10013ca444ca1c2c1c12d21ba1b", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Atualiza metadados da versão (ex.: is_active)", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "method": "PUT", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\",\n \"steps\": {\n \"0\": \"Informações pessoais\",\n \"1\": \"Informações de contato\",\n \"2\": \"Informações de endereço\"\n }\n },\n \"fields\": [\n {\n \"label\": \"Full name\",\n \"type\": \"text\",\n \"placeholder\": \"Type your full name\",\n \"required\": true,\n \"step\": 0,\n \"order\": 1\n },\n {\n \"label\": \"Email\",\n \"type\": \"email\",\n \"placeholder\": \"name@company.com\",\n \"required\": true,\n \"step\": 1,\n \"order\": 2\n },\n {\n \"key\": \"cep_principal\",\n \"label\": \"ZIP code\",\n \"type\": \"cep\",\n \"placeholder\": \"00000-000\",\n \"required\": true,\n \"step\": 2,\n \"order\": 3,\n \"options\": {\n \"fields\": [\n {\n \"label\": \"Street address\",\n \"attribute_type\": \"street\",\n \"required\": true\n },\n {\n \"label\": \"State\",\n \"attribute_type\": \"state\",\n \"required\": true\n },\n {\n \"label\": \"City\",\n \"attribute_type\": \"city\"\n },\n {\n \"label\": \"Neighborhood\",\n \"attribute_type\": \"neighborhood\"\n },\n {\n \"label\": \"Number\",\n \"attribute_type\": \"number\"\n },\n {\n \"label\": \"Complement\",\n \"attribute_type\": \"complement\"\n }\n ]\n }\n },\n {\n \"label\": \"Shipping method\",\n \"type\": \"radio-group\",\n \"placeholder\": \"Choose a shipping method\",\n \"required\": false,\n \"step\": 2,\n \"order\": 6,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"SEDEX\",\n \"value\": \"SEDEX\"\n },\n {\n \"label\": \"Retirar presencialmente\",\n \"value\": \"RETIRAR\"\n },\n {\n \"label\": \"PAC\",\n \"value\": \"PAC\"\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_72159d2900b644b8a63485c952ea0788", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Remove uma versão específica", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "method": "DELETE", + "body": {}, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request_group", + "_id": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "parentId": "fld_eb7ed4b72aa84f34bc95fe2cf0ca494e", + "name": "Exemplos de versões", + "description": "", + "environment": {}, + "environmentPropertyOrder": null, + "metaSortKey": 1000000000004 + }, + { + "_type": "request", + "_id": "req_660b603b129f4817ad661957bd5917b8", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Texto curto", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Full name\",\n \"type\": \"text\",\n \"placeholder\": \"Type your full name\",\n \"help_balloon\": \"Campo de texto simples com limite de caracteres.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"maxlength\": 120\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000000, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_46bb02f3b77743f091be4818afa5f234", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Texto longo", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Notes\",\n \"type\": \"textarea\",\n \"placeholder\": \"Additional comments or context\",\n \"help_balloon\": \"Use este campo para textos longos.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"maxlength\": 2000\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000001, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_a0e63bf555a244ca8e0533dcf4c64cc8", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Número", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Quantity\",\n \"type\": \"number\",\n \"placeholder\": \"0\",\n \"help_balloon\": \"Aceita valores numéricos.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000002, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_6fc6d0831da94990a92621d0d66e2c3b", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Intervalo numérico", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Taxa de administração\",\n \"type\": \"number_range\",\n \"placeholder\": \"Taxa de administração\",\n \"help_balloon\": \"Valor numérico com limites mínimo e máximo, casas decimais e mensagens de erro configuráveis.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"min_value\": 1.2,\n \"max_value\": 4.5,\n \"decimal_places\": 2,\n \"min_error_message\": \"Informe um valor a partir de {min_value} com até {decimal_places} casas decimais.\",\n \"max_error_message\": \"Informe um valor até {max_value} com até {decimal_places} casas decimais.\"\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000003, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_0e08d3e974ce4edaa47e5df2ef059aad", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "E-mail do signatário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Work email\",\n \"type\": \"email\",\n \"placeholder\": \"name@company.com\",\n \"help_balloon\": \"Usaremos este e-mail para notificações.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000004, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_fe62c4593d7140629554b7488ab07d09", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Número de Telefone/Whatsapp", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Phone number\",\n \"type\": \"phone_number\",\n \"placeholder\": \"(11) 98765-4321\",\n \"help_balloon\": \"Formato com DDD.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000005, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_8b3c375d26de46dd9624e42b5f569e7d", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Data", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Birth date\",\n \"type\": \"date\",\n \"placeholder\": \"DD/MM/YYYY\",\n \"help_balloon\": \"Informe uma data válida.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000006, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_f254e3056a204f4eb07606d54eecd09c", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "CPF", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Tax ID (CPF)\",\n \"type\": \"cpf\",\n \"placeholder\": \"000.000.000-00\",\n \"help_balloon\": \"Formato esperado de CPF.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000007, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_9841cc3149e6445cb2f478614c3c8e01", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "CNPJ", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Company ID (CNPJ)\",\n \"type\": \"cnpj\",\n \"placeholder\": \"00.000.000/0000-00\",\n \"help_balloon\": \"Formato esperado de CNPJ.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000008, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_e9d3d629065d4d52bea55b5acbfdc827", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Monetário", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Estimated amount\",\n \"type\": \"currency\",\n \"placeholder\": \"0,00\",\n \"help_balloon\": \"Informe o valor monetário.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000009, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_f37b71030afc4e0da933640b8041a4a4", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "CEP", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"ZIP code\",\n \"type\": \"cep\",\n \"placeholder\": \"00000-000\",\n \"help_balloon\": \"Informe o CEP; os campos abaixo compõem o endereço.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"fields\": [\n {\n \"label\": \"Street address\",\n \"attribute_type\": \"street\",\n \"required\": true,\n \"help_balloon\": \"Preenchido automaticamente quando possível.\"\n },\n {\n \"label\": \"State\",\n \"attribute_type\": \"state\",\n \"required\": true,\n \"help_balloon\": \"UF do endereço.\"\n },\n {\n \"label\": \"City\",\n \"attribute_type\": \"city\",\n \"help_balloon\": \"Município correspondente ao CEP.\"\n },\n {\n \"label\": \"Neighborhood\",\n \"attribute_type\": \"neighborhood\",\n \"help_balloon\": \"Bairro do endereço.\"\n },\n {\n \"label\": \"Number\",\n \"attribute_type\": \"number\",\n \"help_balloon\": \"Número do imóvel (sem letras).\"\n },\n {\n \"label\": \"Complement\",\n \"attribute_type\": \"complement\",\n \"help_balloon\": \"Apartamento, bloco, sala, etc.\"\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000010, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_2a5e6e77c54e415ba9249b9b050b739d", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Imagem", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Document photo\",\n \"type\": \"image\",\n \"placeholder\": \"PNG or JPG\",\n \"help_balloon\": \"Upload restrito a imagens.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000011, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_712de61ce3584636be259952130632cd", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Anexo", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"PDF attachment\",\n \"type\": \"file\",\n \"placeholder\": \"Upload a PDF file\",\n \"help_balloon\": \"Upload de arquivo genérico (ex.: PDF).\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000012, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_1d0e781d0c644792ae1d29d83b154ba8", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Cabeçalho", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Personal data\",\n \"type\": \"header\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000013, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_9a94a56bdd9041afb158188504919e1a", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Parágrafo", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Please review the information below carefully.\",\n \"type\": \"paragraph\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000014, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_d6a32d67897b4627a86afbb5e84f657d", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Lista suspensa", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Marital status\",\n \"type\": \"select\",\n \"placeholder\": \"Select an option\",\n \"help_balloon\": \"Selecione uma opção na lista suspensa.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"values\": [\n {\n \"label\": \"Single\",\n \"value\": \"S\"\n },\n {\n \"label\": \"Married\",\n \"value\": \"C\"\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000015, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_b312ba66639a41a2abbff553bb6e517e", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Única resposta", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Payment method\",\n \"type\": \"radio-group\",\n \"help_balloon\": \"Escolha uma única opção.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"Pix\",\n \"value\": \"PIX\"\n },\n {\n \"label\": \"Card\",\n \"value\": \"CARD\"\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000016, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_2433140a92394cf2b2c3c6a14815cd60", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Múltiplas respostas", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Interests\",\n \"type\": \"checkbox-group\",\n \"help_balloon\": \"Selecione uma ou mais opções.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"Marketing\",\n \"value\": \"MKT\"\n },\n {\n \"label\": \"Product\",\n \"value\": \"PROD\"\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000017, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_e294aa80542849049b5866ce62ed02bc", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Repetidor de campos", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Dependents\",\n \"type\": \"repeater\",\n \"placeholder\": \"Add one row per dependent\",\n \"help_balloon\": \"Adicione um ou mais blocos de dependentes.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"button_label\": \"Add dependent\",\n \"fields\": [\n {\n \"label\": \"Name\",\n \"type\": \"text\",\n \"placeholder\": \"Dependent full name\",\n \"help_balloon\": \"Sub-campo text dentro do repeater.\",\n \"key\": \"dependent_name\",\n \"required\": true,\n \"order\": 1\n }\n ]\n }\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000018, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + }, + { + "_type": "request", + "_id": "req_eed56d8dedab4cef88fe1a359a0889ef", + "parentId": "fld_c9d6bb0fded04d1698a97b2f35aaeeb8", + "name": "Campos com regras condicionais", + "description": "", + "url": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "method": "POST", + "body": { + "mimeType": "application/json", + "text": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Plan\",\n \"type\": \"select\",\n \"placeholder\": \"Choose your plan\",\n \"help_balloon\": \"A seleção pode exibir ou ocultar outros campos.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"values\": [\n {\n \"label\": \"Full\",\n \"value\": \"FULL\"\n },\n {\n \"label\": \"Basic\",\n \"value\": \"BASIC\"\n }\n ]\n },\n \"conditions\": [\n {\n \"action\": \"show\",\n \"operator\": \"equal\",\n \"fields\": [\n \"Plan details\"\n ],\n \"value\": \"FULL\"\n }\n ]\n },\n {\n \"label\": \"Plan details\",\n \"type\": \"text\",\n \"placeholder\": \"Describe coverage needs\",\n \"help_balloon\": \"Exibido quando o plano selecionado for \\\"Full\\\".\",\n \"required\": false,\n \"order\": 2,\n \"step\": 0\n }\n ]\n}" + }, + "parameters": [], + "headers": [ + { + "name": "Content-Type", + "value": "application/json" + }, + { + "name": "Authorization", + "value": "{{ access_token }}" + } + ], + "authentication": { + "type": "apikey", + "disabled": false, + "key": "Authorization", + "value": "{{ access_token }}", + "addTo": "header" + }, + "metaSortKey": 1000000000019, + "isPrivate": false, + "settingStoreCookies": true, + "settingSendCookies": true, + "settingDisableRenderRequestBody": false, + "settingEncodeUrl": true, + "settingRebuildPath": true, + "settingFollowRedirects": "global" + } + ] +} \ No newline at end of file diff --git a/ClickForm_Postman_Collection.json b/ClickForm_Postman_Collection.json new file mode 100644 index 0000000..0dc724b --- /dev/null +++ b/ClickForm_Postman_Collection.json @@ -0,0 +1,2175 @@ +{ + "info": { + "_postman_id": "4098b66e-0557-47b0-94df-33448a160942", + "name": "ClickForm", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "host", + "value": "clickform-sandbox.clicksign.com" + } + ], + "item": [ + { + "name": "Health", + "item": [ + { + "name": "Verifica disponibilidade do serviço", + "request": { + "method": "GET", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/health", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "health" + ] + }, + "auth": { + "type": "noauth" + } + }, + "response": [] + } + ] + }, + { + "name": "Forms", + "item": [ + { + "name": "Lista todos os formulários", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cria o formulário base", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Cadastro de cliente\",\n \"callback_url\": \"https://partner.example.com/hooks/clickform\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Retorna metadados de um formulário específico", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Atualiza os metadados do formulário", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Cadastro de cliente — revisão 2\",\n \"callback_url\": \"https://partner.example.com/hooks/clickform-v2\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Remove um formulário", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Runs", + "item": [ + { + "name": "Lista todas as execuções associadas a uma versão", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/versions/{{version_key}}/runs", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "versions", + "{{version_key}}", + "runs" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cria uma versão pré-preenchida do formulário para preenchimento único", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/versions/{{version_key}}/runs", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "versions", + "{{version_key}}", + "runs" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"callback_url\": \"https://erp.cliente.com/callback\",\n \"context\": {\n \"nome-completo-59661f5fe933\": {\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n \"whatsapp-f9c2322fcc74\": {\n \"value\": \"48999999999\",\n \"read_only\": false\n },\n \"email-6679641e7540\": {\n \"value\": \"john.doe@developer.com\",\n \"read_only\": true\n }\n },\n \"notification\": {\n \"whatsapp\": \"(11) 9 1234-5678\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Obtém uma execução (run) por versão", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "versions", + "{{version_key}}", + "runs", + "{{run_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Atualiza contexto, expires_at ou callback_url do run", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "versions", + "{{version_key}}", + "runs", + "{{run_key}}" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"context\": {\n \"nome-completo-59661f5fe933\": {\n \"value\": \"John Doe\",\n \"read_only\": false\n },\n \"whatsapp-f9c2322fcc74\": {\n \"value\": \"48999999999\",\n \"read_only\": false\n },\n \"email-6679641e7540\": {\n \"value\": \"john.doe@developer.com\",\n \"read_only\": true\n }\n },\n \"expires_at\": \"2026-12-31T23:59:59Z\",\n \"callback_url\": \"https://erp.cliente.com/callback\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Remove uma execução pendente", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "versions", + "{{version_key}}", + "runs", + "{{run_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Versions", + "item": [ + { + "name": "Lista todas as versões de um formulário", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cria uma nova versão (schema) do formulário", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\",\n \"steps\": {\n \"0\": \"Informações pessoais\",\n \"1\": \"Informações de contato\"\n }\n },\n \"fields\": [\n {\n \"label\": \"Nome completo\",\n \"type\": \"text\",\n \"placeholder\": \"Maria da Silva\",\n \"help_balloon\": \"Use o mesmo nome do documento.\",\n \"required\": true,\n \"step\": 0,\n \"order\": 1\n },\n {\n \"label\": \"Whatsapp\",\n \"type\": \"phone_number\",\n \"placeholder\": \"(11) 99999-9999\",\n \"help_balloon\": \"Inclua o DDD para facilitar o retorno.\",\n \"required\": true,\n \"step\": 1\n },\n {\n \"label\": \"Email\",\n \"type\": \"email\",\n \"placeholder\": \"nome@empresa.com\",\n \"help_balloon\": \"Informe um e-mail válido para contato.\",\n \"required\": true,\n \"step\": 1\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Retorna a estrutura da versão", + "request": { + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions", + "{{version_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Atualiza metadados da versão (ex.: is_active)", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions", + "{{version_key}}" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\",\n \"steps\": {\n \"0\": \"Informações pessoais\",\n \"1\": \"Informações de contato\",\n \"2\": \"Informações de endereço\"\n }\n },\n \"fields\": [\n {\n \"label\": \"Full name\",\n \"type\": \"text\",\n \"placeholder\": \"Type your full name\",\n \"required\": true,\n \"step\": 0,\n \"order\": 1\n },\n {\n \"label\": \"Email\",\n \"type\": \"email\",\n \"placeholder\": \"name@company.com\",\n \"required\": true,\n \"step\": 1,\n \"order\": 2\n },\n {\n \"key\": \"cep_principal\",\n \"label\": \"ZIP code\",\n \"type\": \"cep\",\n \"placeholder\": \"00000-000\",\n \"required\": true,\n \"step\": 2,\n \"order\": 3,\n \"options\": {\n \"fields\": [\n {\n \"label\": \"Street address\",\n \"attribute_type\": \"street\",\n \"required\": true\n },\n {\n \"label\": \"State\",\n \"attribute_type\": \"state\",\n \"required\": true\n },\n {\n \"label\": \"City\",\n \"attribute_type\": \"city\"\n },\n {\n \"label\": \"Neighborhood\",\n \"attribute_type\": \"neighborhood\"\n },\n {\n \"label\": \"Number\",\n \"attribute_type\": \"number\"\n },\n {\n \"label\": \"Complement\",\n \"attribute_type\": \"complement\"\n }\n ]\n }\n },\n {\n \"label\": \"Shipping method\",\n \"type\": \"radio-group\",\n \"placeholder\": \"Choose a shipping method\",\n \"required\": false,\n \"step\": 2,\n \"order\": 6,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"SEDEX\",\n \"value\": \"SEDEX\"\n },\n {\n \"label\": \"Retirar presencialmente\",\n \"value\": \"RETIRAR\"\n },\n {\n \"label\": \"PAC\",\n \"value\": \"PAC\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Remove uma versão específica", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}}", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions", + "{{version_key}}" + ] + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Exemplos de versões", + "item": [ + { + "name": "Texto curto", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Full name\",\n \"type\": \"text\",\n \"placeholder\": \"Type your full name\",\n \"help_balloon\": \"Campo de texto simples com limite de caracteres.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"maxlength\": 120\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Texto longo", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Notes\",\n \"type\": \"textarea\",\n \"placeholder\": \"Additional comments or context\",\n \"help_balloon\": \"Use este campo para textos longos.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"maxlength\": 2000\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Número", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Quantity\",\n \"type\": \"number\",\n \"placeholder\": \"0\",\n \"help_balloon\": \"Aceita valores numéricos.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Intervalo numérico", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Taxa de administração\",\n \"type\": \"number_range\",\n \"placeholder\": \"Taxa de administração\",\n \"help_balloon\": \"Valor numérico com limites mínimo e máximo, casas decimais e mensagens de erro configuráveis.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"min_value\": 1.2,\n \"max_value\": 4.5,\n \"decimal_places\": 2,\n \"min_error_message\": \"Informe um valor a partir de {min_value} com até {decimal_places} casas decimais.\",\n \"max_error_message\": \"Informe um valor até {max_value} com até {decimal_places} casas decimais.\"\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "E-mail do signatário", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Work email\",\n \"type\": \"email\",\n \"placeholder\": \"name@company.com\",\n \"help_balloon\": \"Usaremos este e-mail para notificações.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Número de Telefone/Whatsapp", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Phone number\",\n \"type\": \"phone_number\",\n \"placeholder\": \"(11) 98765-4321\",\n \"help_balloon\": \"Formato com DDD.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Data", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Birth date\",\n \"type\": \"date\",\n \"placeholder\": \"DD/MM/YYYY\",\n \"help_balloon\": \"Informe uma data válida.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "CPF", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Tax ID (CPF)\",\n \"type\": \"cpf\",\n \"placeholder\": \"000.000.000-00\",\n \"help_balloon\": \"Formato esperado de CPF.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "CNPJ", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Company ID (CNPJ)\",\n \"type\": \"cnpj\",\n \"placeholder\": \"00.000.000/0000-00\",\n \"help_balloon\": \"Formato esperado de CNPJ.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Monetário", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Estimated amount\",\n \"type\": \"currency\",\n \"placeholder\": \"0,00\",\n \"help_balloon\": \"Informe o valor monetário.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "CEP", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"ZIP code\",\n \"type\": \"cep\",\n \"placeholder\": \"00000-000\",\n \"help_balloon\": \"Informe o CEP; os campos abaixo compõem o endereço.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"fields\": [\n {\n \"label\": \"Street address\",\n \"attribute_type\": \"street\",\n \"required\": true,\n \"help_balloon\": \"Preenchido automaticamente quando possível.\"\n },\n {\n \"label\": \"State\",\n \"attribute_type\": \"state\",\n \"required\": true,\n \"help_balloon\": \"UF do endereço.\"\n },\n {\n \"label\": \"City\",\n \"attribute_type\": \"city\",\n \"help_balloon\": \"Município correspondente ao CEP.\"\n },\n {\n \"label\": \"Neighborhood\",\n \"attribute_type\": \"neighborhood\",\n \"help_balloon\": \"Bairro do endereço.\"\n },\n {\n \"label\": \"Number\",\n \"attribute_type\": \"number\",\n \"help_balloon\": \"Número do imóvel (sem letras).\"\n },\n {\n \"label\": \"Complement\",\n \"attribute_type\": \"complement\",\n \"help_balloon\": \"Apartamento, bloco, sala, etc.\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Imagem", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Document photo\",\n \"type\": \"image\",\n \"placeholder\": \"PNG or JPG\",\n \"help_balloon\": \"Upload restrito a imagens.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Anexo", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"PDF attachment\",\n \"type\": \"file\",\n \"placeholder\": \"Upload a PDF file\",\n \"help_balloon\": \"Upload de arquivo genérico (ex.: PDF).\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Cabeçalho", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Personal data\",\n \"type\": \"header\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Parágrafo", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Please review the information below carefully.\",\n \"type\": \"paragraph\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Lista suspensa", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Marital status\",\n \"type\": \"select\",\n \"placeholder\": \"Select an option\",\n \"help_balloon\": \"Selecione uma opção na lista suspensa.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"values\": [\n {\n \"label\": \"Single\",\n \"value\": \"S\"\n },\n {\n \"label\": \"Married\",\n \"value\": \"C\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Única resposta", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Payment method\",\n \"type\": \"radio-group\",\n \"help_balloon\": \"Escolha uma única opção.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"Pix\",\n \"value\": \"PIX\"\n },\n {\n \"label\": \"Card\",\n \"value\": \"CARD\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Múltiplas respostas", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Interests\",\n \"type\": \"checkbox-group\",\n \"help_balloon\": \"Selecione uma ou mais opções.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"other\": true,\n \"values\": [\n {\n \"label\": \"Marketing\",\n \"value\": \"MKT\"\n },\n {\n \"label\": \"Product\",\n \"value\": \"PROD\"\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Repetidor de campos", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Dependents\",\n \"type\": \"repeater\",\n \"placeholder\": \"Add one row per dependent\",\n \"help_balloon\": \"Adicione um ou mais blocos de dependentes.\",\n \"required\": false,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"button_label\": \"Add dependent\",\n \"fields\": [\n {\n \"label\": \"Name\",\n \"type\": \"text\",\n \"placeholder\": \"Dependent full name\",\n \"help_balloon\": \"Sub-campo text dentro do repeater.\",\n \"key\": \"dependent_name\",\n \"required\": true,\n \"order\": 1\n }\n ]\n }\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + }, + { + "name": "Campos com regras condicionais", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "{{access_token}}", + "type": "text" + }, + { + "key": "Content-Type", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "https://{{host}}/api/v1/forms/{{form_key}}/versions", + "protocol": "https", + "host": [ + "{{host}}" + ], + "path": [ + "api", + "v1", + "forms", + "{{form_key}}", + "versions" + ] + }, + "body": { + "mode": "raw", + "raw": "{\n \"settings\": {\n \"title\": \"Atualização de contato\",\n \"subtitle\": \"Por favor, confirme os dados de contato.\",\n \"finish_title\": \"Atualização de dados concluída!\",\n \"finish_subtitle\": \"Em breve nossa equipe entrará em contato.\",\n \"finish_info\": \"Visite nosso site para mais informações.\"\n },\n \"fields\": [\n {\n \"label\": \"Plan\",\n \"type\": \"select\",\n \"placeholder\": \"Choose your plan\",\n \"help_balloon\": \"A seleção pode exibir ou ocultar outros campos.\",\n \"required\": true,\n \"order\": 1,\n \"step\": 0,\n \"options\": {\n \"values\": [\n {\n \"label\": \"Full\",\n \"value\": \"FULL\"\n },\n {\n \"label\": \"Basic\",\n \"value\": \"BASIC\"\n }\n ]\n },\n \"conditions\": [\n {\n \"action\": \"show\",\n \"operator\": \"equal\",\n \"fields\": [\n \"Plan details\"\n ],\n \"value\": \"FULL\"\n }\n ]\n },\n {\n \"label\": \"Plan details\",\n \"type\": \"text\",\n \"placeholder\": \"Describe coverage needs\",\n \"help_balloon\": \"Exibido quando o plano selecionado for \\\"Full\\\".\",\n \"required\": false,\n \"order\": 2,\n \"step\": 0\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "key", + "value": "Authorization", + "type": "string" + }, + { + "key": "value", + "value": "{{access_token}}", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + } + ] + } + }, + "response": [] + } + ] + } + ] + } + ] +} \ No newline at end of file diff --git a/ClickForm_Postman_Environment.json b/ClickForm_Postman_Environment.json new file mode 100644 index 0000000..46d4b00 --- /dev/null +++ b/ClickForm_Postman_Environment.json @@ -0,0 +1,57 @@ +{ + "id": "a91a566a-89bb-48f1-97d7-ab8f6fc8ad1a", + "name": "ClickForm - Sandbox", + "values": [ + { + "key": "host", + "value": "clickform-sandbox.clicksign.com", + "type": "default", + "enabled": true + }, + { + "key": "host_production", + "value": "clickform.clicksign.com", + "type": "default", + "enabled": false + }, + { + "key": "access_token", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "flow_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "execution_id", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "form_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "version_key", + "value": "", + "type": "default", + "enabled": true + }, + { + "key": "run_key", + "value": "", + "type": "default", + "enabled": true + } + ], + "_postman_variable_scope": "environment", + "_postman_exported_at": "2026-09-15T20:46:04.653Z", + "_postman_exported_using": "generate-collections.js" +} \ No newline at end of file diff --git a/README.md b/README.md index 3efa06d..5a0d276 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,56 @@ Este repositório contém collections para facilitar o teste e a integração co ## Conteúdo do Repositório +### Clicksign API v3 + - **Postman Collection**: Arquivo JSON das collections que pode ser importado diretamente no Postman. - **Postman Environment**: Arquivo JSON das variáveis de ambiente que pode ser importado diretamente no Postman. - **Insomnia Collection**: Arquivo JSON das collections que pode ser importado diretamente no Insomnia. - **Insomnia Expert Collection**: Arquivo JSON com collections de todas versões da API da Clicksign (Sugerido para quem precisa de recursos avançados). +### ClickFlow e ClickForm + +Collections geradas a partir das specs públicas (`/api/v1`, sem rotas internas). Host padrão: **sandbox**. + +| Produto | Postman | Insomnia | Bruno | +|---------|---------|----------|-------| +| ClickFlow Orchestrator | `ClickFlow_Orchestrator_Postman_Collection.json` + `_Environment.json` | `ClickFlow_Orchestrator_Insomnia_Collection.json` | `bruno/ClickFlow_Orchestrator/` | +| ClickFlow Runner | `ClickFlow_Runner_Postman_Collection.json` + `_Environment.json` | `ClickFlow_Runner_Insomnia_Collection.json` | `bruno/ClickFlow_Runner/` | +| ClickForm | `ClickForm_Postman_Collection.json` + `_Environment.json` | `ClickForm_Insomnia_Collection.json` | `bruno/ClickForm/` | + +**Hosts sandbox (padrão):** + +- Orchestrator: `clickflow-sandbox.clicksign.com` +- Runner: `clickflow-runner-sandbox.clicksign.com` +- Form: `clickform-sandbox.clicksign.com` + +Autenticação: header `Authorization` com UUID (`{{access_token}}`), sem prefixo `Bearer`. Endpoints `/health` não exigem auth. + --- ## Como Usar as Collections ### **Postman** -1. Faça o download do arquivo `Clicksign_Postman_Collection.json`. +1. Faça o download do arquivo `Clicksign_Postman_Collection.json` (API v3) ou das collections ClickFlow/ClickForm listadas acima. 2. Abra o Postman. 3. Vá até o menu **File > Import**. 4. Selecione o arquivo baixado e importe. -5. Importe também as variáveis de ambiente `Clicksign_Postman_Environment.json`. +5. Importe também as variáveis de ambiente correspondentes (`Clicksign_Postman_Environment.json` ou `ClickFlow_*` / `ClickForm_*_Environment.json`). O host padrão do Flow/Form é sandbox. ### **Insomnia** -1. Faça o download do arquivo `Clicksign_Insomnia_Collection.json`. +1. Faça o download do arquivo `Insomnia_Collection.json` (API v3) ou das collections ClickFlow/ClickForm listadas acima. 2. Abra o Insomnia. 3. Clique no menu de Workspaces e selecione **Import/Export > Import Data**. 4. Escolha a opção **From File** e selecione o arquivo baixado. +### **Bruno** (ClickFlow / ClickForm) + +1. Abra o Bruno e selecione **Open Collection**. +2. Aponte para a pasta `bruno/ClickFlow_Orchestrator`, `bruno/ClickFlow_Runner` ou `bruno/ClickForm`. +3. Selecione o ambiente **Sandbox** e preencha `access_token`. + --- ## Configuração da API Key diff --git a/bruno/ClickFlow_Orchestrator/bruno.json b/bruno/ClickFlow_Orchestrator/bruno.json new file mode 100644 index 0000000..0014ac9 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/bruno.json @@ -0,0 +1,9 @@ +{ + "version": "1", + "name": "ClickFlow Orchestrator", + "type": "collection", + "ignore": [ + "node_modules", + ".git" + ] +} \ No newline at end of file diff --git a/bruno/ClickFlow_Orchestrator/collection.bru b/bruno/ClickFlow_Orchestrator/collection.bru new file mode 100644 index 0000000..4a6ca6e --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/collection.bru @@ -0,0 +1,9 @@ +auth { + mode: apikey +} + +auth:apikey { + key: Authorization + value: {{access_token}} + placement: header +} diff --git a/bruno/ClickFlow_Orchestrator/environments/Producao.bru b/bruno/ClickFlow_Orchestrator/environments/Producao.bru new file mode 100644 index 0000000..7fdb62a --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/environments/Producao.bru @@ -0,0 +1,9 @@ +vars { + host: clickflow.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickFlow_Orchestrator/environments/Sandbox.bru b/bruno/ClickFlow_Orchestrator/environments/Sandbox.bru new file mode 100644 index 0000000..8aedb70 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/environments/Sandbox.bru @@ -0,0 +1,9 @@ +vars { + host: clickflow-sandbox.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickFlow_Orchestrator/executions/002-estado-da-execucao.bru b/bruno/ClickFlow_Orchestrator/executions/002-estado-da-execucao.bru new file mode 100644 index 0000000..8fc00f1 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/002-estado-da-execucao.bru @@ -0,0 +1,11 @@ +meta { + name: Estado da execução + type: http + seq: 2 +} + +get { + url: https://{{host}}/api/v1/executions/{{execution_id}} + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/executions/003-cancela-uma-execucao-em-andamento.bru b/bruno/ClickFlow_Orchestrator/executions/003-cancela-uma-execucao-em-andamento.bru new file mode 100644 index 0000000..64b0da2 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/003-cancela-uma-execucao-em-andamento.bru @@ -0,0 +1,11 @@ +meta { + name: Cancela uma execução em andamento + type: http + seq: 3 +} + +post { + url: https://{{host}}/api/v1/executions/{{execution_id}}/cancel + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/executions/004-avanca-para-o-proximo-passo.bru b/bruno/ClickFlow_Orchestrator/executions/004-avanca-para-o-proximo-passo.bru new file mode 100644 index 0000000..7262af1 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/004-avanca-para-o-proximo-passo.bru @@ -0,0 +1,11 @@ +meta { + name: Avança para o próximo passo + type: http + seq: 4 +} + +post { + url: https://{{host}}/api/v1/executions/{{execution_id}}/next + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/executions/005-lista-execucoes-de-um-flow.bru b/bruno/ClickFlow_Orchestrator/executions/005-lista-execucoes-de-um-flow.bru new file mode 100644 index 0000000..d4a266a --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/005-lista-execucoes-de-um-flow.bru @@ -0,0 +1,11 @@ +meta { + name: Lista execuções de um flow + type: http + seq: 5 +} + +get { + url: https://{{host}}/api/v1/flows/{{flow_id}}/executions + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/executions/006-inicia-execucao-de-um-flow-publicado.bru b/bruno/ClickFlow_Orchestrator/executions/006-inicia-execucao-de-um-flow-publicado.bru new file mode 100644 index 0000000..e52c217 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/006-inicia-execucao-de-um-flow-publicado.bru @@ -0,0 +1,11 @@ +meta { + name: Inicia execução de um flow publicado + type: http + seq: 6 +} + +post { + url: https://{{host}}/api/v1/flows/{{flow_id}}/executions + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/executions/folder.bru b/bruno/ClickFlow_Orchestrator/executions/folder.bru new file mode 100644 index 0000000..c7a4c0c --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/executions/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Executions +} diff --git a/bruno/ClickFlow_Orchestrator/flows/007-lista-flows.bru b/bruno/ClickFlow_Orchestrator/flows/007-lista-flows.bru new file mode 100644 index 0000000..1156821 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/007-lista-flows.bru @@ -0,0 +1,11 @@ +meta { + name: Lista flows + type: http + seq: 7 +} + +get { + url: https://{{host}}/api/v1/flows + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/flows/008-cria-flow.bru b/bruno/ClickFlow_Orchestrator/flows/008-cria-flow.bru new file mode 100644 index 0000000..2db5fde --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/008-cria-flow.bru @@ -0,0 +1,29 @@ +meta { + name: Cria flow + type: http + seq: 8 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — acceptance", + "steps": [ + { + "context": { + "accept_replies": [ + "accept", + "aceitar" + ], + "template_key": "chave-do-template" + }, + "type": "acceptance" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/009-obtem-flow-por-id.bru b/bruno/ClickFlow_Orchestrator/flows/009-obtem-flow-por-id.bru new file mode 100644 index 0000000..926ca5b --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/009-obtem-flow-por-id.bru @@ -0,0 +1,11 @@ +meta { + name: Obtém flow por ID + type: http + seq: 9 +} + +get { + url: https://{{host}}/api/v1/flows/{{flow_id}} + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/flows/010-atualiza-flow.bru b/bruno/ClickFlow_Orchestrator/flows/010-atualiza-flow.bru new file mode 100644 index 0000000..58654d2 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/010-atualiza-flow.bru @@ -0,0 +1,29 @@ +meta { + name: Atualiza flow + type: http + seq: 10 +} + +put { + url: https://{{host}}/api/v1/flows/{{flow_id}} + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — acceptance", + "steps": [ + { + "context": { + "accept_replies": [ + "accept", + "aceitar" + ], + "template_key": "chave-do-template" + }, + "type": "acceptance" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/011-remove-flow.bru b/bruno/ClickFlow_Orchestrator/flows/011-remove-flow.bru new file mode 100644 index 0000000..fc31532 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/011-remove-flow.bru @@ -0,0 +1,11 @@ +meta { + name: Remove flow + type: http + seq: 11 +} + +delete { + url: https://{{host}}/api/v1/flows/{{flow_id}} + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/flows/012-publica-flow-draft-ou-unpublished-published.bru b/bruno/ClickFlow_Orchestrator/flows/012-publica-flow-draft-ou-unpublished-published.bru new file mode 100644 index 0000000..dc7a798 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/012-publica-flow-draft-ou-unpublished-published.bru @@ -0,0 +1,11 @@ +meta { + name: Publica flow (draft ou unpublished → published) + type: http + seq: 12 +} + +patch { + url: https://{{host}}/api/v1/flows/{{flow_id}}/publish + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/flows/013-despublica-flow-published-unpublished.bru b/bruno/ClickFlow_Orchestrator/flows/013-despublica-flow-published-unpublished.bru new file mode 100644 index 0000000..f892256 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/013-despublica-flow-published-unpublished.bru @@ -0,0 +1,11 @@ +meta { + name: Despublica flow (published → unpublished) + type: http + seq: 13 +} + +patch { + url: https://{{host}}/api/v1/flows/{{flow_id}}/unpublish + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/014-consent.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/014-consent.bru new file mode 100644 index 0000000..27a58cc --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/014-consent.bru @@ -0,0 +1,26 @@ +meta { + name: Consent + type: http + seq: 14 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — consent", + "steps": [ + { + "context": { + "channel_type": "whatsapp", + "template_id": "seu-template-id" + }, + "type": "consent" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/015-consent-variaveis-por-step-channel-params.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/015-consent-variaveis-por-step-channel-params.bru new file mode 100644 index 0000000..d161341 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/015-consent-variaveis-por-step-channel-params.bru @@ -0,0 +1,41 @@ +meta { + name: Consent — variáveis por step (channel_params) + type: http + seq: 15 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — consent com variáveis", + "steps": [ + { + "context": { + "channel_params": { + "steps": [ + { + "step_id": "apresentacao", + "variables": { + "body": [ + "{{person_name}}", + "Carro Azul", + "{{cpf_form_field}}" + ], + "header": [] + } + } + ] + }, + "channel_type": "whatsapp", + "template_id": "seu-template-id" + }, + "type": "consent" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/016-form.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/016-form.bru new file mode 100644 index 0000000..f27b420 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/016-form.bru @@ -0,0 +1,25 @@ +meta { + name: Form + type: http + seq: 16 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — form", + "steps": [ + { + "context": { + "version_key": "sua-form-version-key" + }, + "type": "form" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/017-form-atualizacao-de-contato.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/017-form-atualizacao-de-contato.bru new file mode 100644 index 0000000..c18bf5c --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/017-form-atualizacao-de-contato.bru @@ -0,0 +1,31 @@ +meta { + name: Form — atualização de contato + type: http + seq: 17 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — form com atualização de contato", + "steps": [ + { + "context": { + "contact": { + "person_birthday": "person-birthday-b8f2a1c3d4e5", + "person_documentation": "person-documentation-d0349c5e8e90", + "person_name": "person-name-4e578ecaa76c", + "phone_number": "phone-number-3d172314e41b" + }, + "version_key": "a0cfcec8-4d18-49a8-b6d1-85df293d5cb4" + }, + "type": "form" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/018-form-injecao-de-respostas-de-formularios-anteriores.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/018-form-injecao-de-respostas-de-formularios-anteriores.bru new file mode 100644 index 0000000..d732150 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/018-form-injecao-de-respostas-de-formularios-anteriores.bru @@ -0,0 +1,49 @@ +meta { + name: Form — Injeção de respostas de formulários anteriores + type: http + seq: 18 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Injeção de respostas de formulários anteriores", + "steps": [ + { + "context": { + "version_key": "versao-formulario-cadastro" + }, + "type": "form" + }, + { + "context": { + "context_map_keys": { + "campo-destino-formulario-atual": { + "read_only": false, + "value": "campo-origem" + }, + "email-confirmacao": { + "read_only": true, + "value": "email-cadastro" + }, + "nome-completo-confirmacao": { + "read_only": false, + "value": "nome-completo-cadastro" + }, + "whatsapp-confirmacao": { + "read_only": true, + "value": "whatsapp-cadastro" + } + }, + "version_key": "versao-formulario-confirmacao" + }, + "type": "form" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/019-form-injecao-do-contato-no-formulario.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/019-form-injecao-do-contato-no-formulario.bru new file mode 100644 index 0000000..1c42ddb --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/019-form-injecao-do-contato-no-formulario.bru @@ -0,0 +1,43 @@ +meta { + name: Form — Injeção do contato no formulário + type: http + seq: 19 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Injeção do contato no formulário", + "steps": [ + { + "context": { + "context_map_keys": { + "cpf": { + "read_only": true, + "value": "{{person_documentation}}" + }, + "data-nascimento": { + "read_only": true, + "value": "{{person_birthday}}" + }, + "nome-completo": { + "read_only": true, + "value": "{{person_name}}" + }, + "whatsapp": { + "read_only": true, + "value": "{{phone_number}}" + } + }, + "version_key": "versao-formulario-confirmacao" + }, + "type": "form" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/020-kyc-biometric-behavior-kyc-cnpj.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/020-kyc-biometric-behavior-kyc-cnpj.bru new file mode 100644 index 0000000..b24d412 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/020-kyc-biometric-behavior-kyc-cnpj.bru @@ -0,0 +1,32 @@ +meta { + name: KYC — biometric_behavior + kyc (CNPJ) + type: http + seq: 20 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify biometric_behavior + kyc (CNPJ)", + "steps": [ + { + "context": { + "authentication": "biometric_behavior", + "result_policy": "passthrough" + }, + "type": "verify" + }, + { + "context": { + "type": "business" + }, + "type": "kyc" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/021-kyc-form-biometric-behavior-kyc-cpf.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/021-kyc-form-biometric-behavior-kyc-cpf.bru new file mode 100644 index 0000000..8b64185 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/021-kyc-form-biometric-behavior-kyc-cpf.bru @@ -0,0 +1,42 @@ +meta { + name: KYC — form + biometric_behavior + kyc (CPF) + type: http + seq: 21 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — form + verify biometric_behavior + kyc (CPF)", + "steps": [ + { + "context": { + "version_key": "sua-form-version-key" + }, + "type": "form" + }, + { + "context": { + "authentication": "biometric_behavior", + "contact_fields_map": { + "person_documentation": "field-key-do-documento", + "person_name": "field-key-do-nome" + }, + "result_policy": "passthrough" + }, + "type": "verify" + }, + { + "context": { + "type": "customer" + }, + "type": "kyc" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/022-signature-template-configuracoes-do-envelope.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/022-signature-template-configuracoes-do-envelope.bru new file mode 100644 index 0000000..dda62ab --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/022-signature-template-configuracoes-do-envelope.bru @@ -0,0 +1,54 @@ +meta { + name: Signature — template + configurações do envelope + type: http + seq: 22 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — assinatura com configurações do envelope", + "steps": [ + { + "context": { + "contact": { + "person_birthday": "person-birthday-b8f2a1c3d4e5", + "person_documentation": "person-documentation-d0349c5e8e90", + "person_name": "person-name-4e578ecaa76c", + "phone_number": "phone-number-3d172314e41b" + }, + "version_key": "a0cfcec8-4d18-49a8-b6d1-85df293d5cb4" + }, + "type": "form" + }, + { + "context": { + "documents": [ + { + "filename": "{{person_name}}_settings.docx", + "kind": "template", + "template_key": "uuid-do-modelo-tavola" + } + ], + "settings": { + "auto_close": false, + "block_after_refusal": false, + "deadline_at": 30, + "default_message": "Documento referente a {{data-contrato-d0349c5e8e90}}.", + "default_subject": "Assine seu documento, {{person_name}}", + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a", + "locale": "en-US", + "name": "Envelope {{person_name}} — {{data-contrato-d0349c5e8e90}}", + "remind_interval": "2" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/023-signature-arquivo-s3.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/023-signature-arquivo-s3.bru new file mode 100644 index 0000000..dc90e27 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/023-signature-arquivo-s3.bru @@ -0,0 +1,35 @@ +meta { + name: Signature — arquivo S3 + type: http + seq: 23 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito", + "steps": [ + { + "context": { + "documents": [ + { + "filename": "contrato-proposta.pdf", + "kind": "file", + "s3_bucket": "meu-bucket", + "s3_key": "caminho/para/contrato.pdf" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/024-signature-filename-com-interpolacao.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/024-signature-filename-com-interpolacao.bru new file mode 100644 index 0000000..de36fbb --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/024-signature-filename-com-interpolacao.bru @@ -0,0 +1,47 @@ +meta { + name: Signature — filename com interpolação + type: http + seq: 24 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — form + signature com filename", + "steps": [ + { + "context": { + "contact": { + "person_birthday": "person-birthday-b8f2a1c3d4e5", + "person_documentation": "person-documentation-d0349c5e8e90", + "person_name": "person-name-4e578ecaa76c", + "phone_number": "phone-number-3d172314e41b" + }, + "version_key": "a0cfcec8-4d18-49a8-b6d1-85df293d5cb4" + }, + "type": "form" + }, + { + "context": { + "documents": [ + { + "filename": "doc_{{person_name}}_{{field-key-do-version}}.docx", + "kind": "template", + "template_key": "uuid-do-modelo-tavola" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a", + "name": "Envelope {{person_name}}" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/025-signature-arquivo-s3-modelo-tavola.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/025-signature-arquivo-s3-modelo-tavola.bru new file mode 100644 index 0000000..40c3542 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/025-signature-arquivo-s3-modelo-tavola.bru @@ -0,0 +1,40 @@ +meta { + name: Signature — arquivo S3 + modelo Tavola + type: http + seq: 25 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — arquivo S3 + template", + "steps": [ + { + "context": { + "documents": [ + { + "filename": "anexo.pdf", + "kind": "file", + "s3_bucket": "meu-bucket", + "s3_key": "caminho/para/anexo.pdf" + }, + { + "filename": "contrato.docx", + "kind": "template", + "template_key": "uuid-do-modelo-tavola" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/026-signature-runner-files.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/026-signature-runner-files.bru new file mode 100644 index 0000000..fafb7a0 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/026-signature-runner-files.bru @@ -0,0 +1,34 @@ +meta { + name: Signature — runner_files + type: http + seq: 26 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — runner_files", + "steps": [ + { + "context": { + "documents": [ + { + "filename": "contrato.pdf", + "key": "1", + "kind": "runner_files" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/027-signature-template-signatarios-extras.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/027-signature-template-signatarios-extras.bru new file mode 100644 index 0000000..0af510b --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/027-signature-template-signatarios-extras.bru @@ -0,0 +1,73 @@ +meta { + name: Signature — template + signatários extras + type: http + seq: 27 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — assinatura com signatários extras", + "steps": [ + { + "context": { + "documents": [ + { + "filename": "{{person_name}}.docx", + "kind": "template", + "template_key": "uuid-do-modelo-tavola" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a", + "name": "Envelope {{person_name}}" + }, + "signers": [ + { + "auths": [ + "handwritten" + ], + "birthday": "2021-07-15", + "communicate_events": { + "document_signed": "email", + "signature_reminder": "email", + "signature_request": "email" + }, + "documentation": "34623794024", + "email": "signatario.fixo@mail.com", + "group": 1, + "has_documentation": true, + "location_required_enabled": true, + "name": "Signatário Fixo", + "phone_number": "49999999999", + "refusable": false, + "roles": [ + "witness" + ] + }, + { + "auths": [ + "liveness", + "whatsapp" + ], + "birthday": "{{person_birthday}}", + "documentation": "{{person_documentation}}", + "group": 2, + "name": "{{person_name}}", + "phone_number": "{{phone_number}}", + "roles": [ + "sign" + ] + } + ] + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/028-signature-modelo-tavola.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/028-signature-modelo-tavola.bru new file mode 100644 index 0000000..d5868ac --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/028-signature-modelo-tavola.bru @@ -0,0 +1,34 @@ +meta { + name: Signature — modelo Tavola + type: http + seq: 28 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — template", + "steps": [ + { + "context": { + "documents": [ + { + "filename": "contrato-proposta.docx", + "kind": "template", + "template_key": "uuid-do-modelo-tavola" + } + ], + "settings": { + "folder_key": "1fb29ab8-84c4-4856-be37-5fce0f17c11a" + } + }, + "type": "signature" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/029-verify-liveness.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/029-verify-liveness.bru new file mode 100644 index 0000000..729d431 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/029-verify-liveness.bru @@ -0,0 +1,25 @@ +meta { + name: Verify — liveness + type: http + seq: 29 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify", + "steps": [ + { + "context": { + "authentication": "liveness" + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/030-verify-biometric-behavior.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/030-verify-biometric-behavior.bru new file mode 100644 index 0000000..93fa223 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/030-verify-biometric-behavior.bru @@ -0,0 +1,25 @@ +meta { + name: Verify — biometric_behavior + type: http + seq: 30 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify biometric_behavior", + "steps": [ + { + "context": { + "authentication": "biometric_behavior" + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/031-verify-biometric-behavior-form.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/031-verify-biometric-behavior-form.bru new file mode 100644 index 0000000..e54311f --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/031-verify-biometric-behavior-form.bru @@ -0,0 +1,35 @@ +meta { + name: Verify — biometric_behavior + form + type: http + seq: 31 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify biometric_behavior + form", + "steps": [ + { + "context": { + "version_key": "sua-form-version-key" + }, + "type": "form" + }, + { + "context": { + "authentication": "biometric_behavior", + "contact_fields_map": { + "person_documentation": "field-key-do-documento", + "person_name": "field-key-do-nome" + } + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/032-verify-identity-biometrics.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/032-verify-identity-biometrics.bru new file mode 100644 index 0000000..4657d0c --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/032-verify-identity-biometrics.bru @@ -0,0 +1,25 @@ +meta { + name: Verify — identity_biometrics + type: http + seq: 32 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify identity_biometrics", + "steps": [ + { + "context": { + "authentication": "identity_biometrics" + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/033-verify-instructions.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/033-verify-instructions.bru new file mode 100644 index 0000000..cc0ecb2 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/033-verify-instructions.bru @@ -0,0 +1,26 @@ +meta { + name: Verify — instructions + type: http + seq: 33 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify instructions", + "steps": [ + { + "context": { + "authentication": "liveness", + "instructions": true + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/034-verify-provider-priority.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/034-verify-provider-priority.bru new file mode 100644 index 0000000..938d4ff --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/034-verify-provider-priority.bru @@ -0,0 +1,29 @@ +meta { + name: Verify — provider_priority + type: http + seq: 34 +} + +post { + url: https://{{host}}/api/v1/flows + body: json + auth: inherit +} + +body:json { +{ + "name": "Proposta Crédito — verify provider_priority", + "steps": [ + { + "context": { + "authentication": "liveness", + "provider_priority": [ + "caf", + "clearsale" + ] + }, + "type": "verify" + } + ] +} +} diff --git a/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/folder.bru b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/folder.bru new file mode 100644 index 0000000..b8eb025 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/exemplos-de-flows/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Exemplos de Flows +} diff --git a/bruno/ClickFlow_Orchestrator/flows/folder.bru b/bruno/ClickFlow_Orchestrator/flows/folder.bru new file mode 100644 index 0000000..387bcb6 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/flows/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Flows +} diff --git a/bruno/ClickFlow_Orchestrator/health/001-health-check.bru b/bruno/ClickFlow_Orchestrator/health/001-health-check.bru new file mode 100644 index 0000000..8dcba46 --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/health/001-health-check.bru @@ -0,0 +1,15 @@ +meta { + name: Health check + type: http + seq: 1 +} + +get { + url: https://{{host}}/health + body: none + auth: none +} + +headers { + Content-Type: application/json +} diff --git a/bruno/ClickFlow_Orchestrator/health/folder.bru b/bruno/ClickFlow_Orchestrator/health/folder.bru new file mode 100644 index 0000000..0dba28c --- /dev/null +++ b/bruno/ClickFlow_Orchestrator/health/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Health +} diff --git a/bruno/ClickFlow_Runner/bruno.json b/bruno/ClickFlow_Runner/bruno.json new file mode 100644 index 0000000..61c886e --- /dev/null +++ b/bruno/ClickFlow_Runner/bruno.json @@ -0,0 +1,9 @@ +{ + "version": "1", + "name": "ClickFlow Runner", + "type": "collection", + "ignore": [ + "node_modules", + ".git" + ] +} \ No newline at end of file diff --git a/bruno/ClickFlow_Runner/collection.bru b/bruno/ClickFlow_Runner/collection.bru new file mode 100644 index 0000000..4a6ca6e --- /dev/null +++ b/bruno/ClickFlow_Runner/collection.bru @@ -0,0 +1,9 @@ +auth { + mode: apikey +} + +auth:apikey { + key: Authorization + value: {{access_token}} + placement: header +} diff --git a/bruno/ClickFlow_Runner/environments/Producao.bru b/bruno/ClickFlow_Runner/environments/Producao.bru new file mode 100644 index 0000000..c38dd78 --- /dev/null +++ b/bruno/ClickFlow_Runner/environments/Producao.bru @@ -0,0 +1,9 @@ +vars { + host: clickflow-runner.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickFlow_Runner/environments/Sandbox.bru b/bruno/ClickFlow_Runner/environments/Sandbox.bru new file mode 100644 index 0000000..0f6c71e --- /dev/null +++ b/bruno/ClickFlow_Runner/environments/Sandbox.bru @@ -0,0 +1,9 @@ +vars { + host: clickflow-runner-sandbox.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickFlow_Runner/executions/002-retorna-uma-execucao.bru b/bruno/ClickFlow_Runner/executions/002-retorna-uma-execucao.bru new file mode 100644 index 0000000..5ba1a3f --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/002-retorna-uma-execucao.bru @@ -0,0 +1,11 @@ +meta { + name: Retorna uma execução + type: http + seq: 2 +} + +get { + url: https://{{host}}/api/v1/executions/{{execution_id}} + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Runner/executions/003-cancela-uma-execucao.bru b/bruno/ClickFlow_Runner/executions/003-cancela-uma-execucao.bru new file mode 100644 index 0000000..b30e5b5 --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/003-cancela-uma-execucao.bru @@ -0,0 +1,11 @@ +meta { + name: Cancela uma execução + type: http + seq: 3 +} + +post { + url: https://{{host}}/api/v1/executions/{{execution_id}}/cancel + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Runner/executions/004-lista-os-steps-de-uma-execucao.bru b/bruno/ClickFlow_Runner/executions/004-lista-os-steps-de-uma-execucao.bru new file mode 100644 index 0000000..154a49c --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/004-lista-os-steps-de-uma-execucao.bru @@ -0,0 +1,11 @@ +meta { + name: Lista os steps de uma execução + type: http + seq: 4 +} + +get { + url: https://{{host}}/api/v1/executions/{{execution_id}}/steps + body: none + auth: inherit +} diff --git a/bruno/ClickFlow_Runner/executions/005-inicia-execucao-whatsapp.bru b/bruno/ClickFlow_Runner/executions/005-inicia-execucao-whatsapp.bru new file mode 100644 index 0000000..168e4d9 --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/005-inicia-execucao-whatsapp.bru @@ -0,0 +1,20 @@ +meta { + name: Inicia execução — WhatsApp + type: http + seq: 5 +} + +post { + url: https://{{host}}/api/v1/flows/{{flow_id}}/execute + body: json + auth: inherit +} + +body:json { +{ + "contact": { + "person_name": "Maria da Silva", + "phone_number": "5511999999999" + } +} +} diff --git a/bruno/ClickFlow_Runner/executions/006-inicia-execucao-canal-api.bru b/bruno/ClickFlow_Runner/executions/006-inicia-execucao-canal-api.bru new file mode 100644 index 0000000..9a5f85c --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/006-inicia-execucao-canal-api.bru @@ -0,0 +1,21 @@ +meta { + name: Inicia execução — canal API + type: http + seq: 6 +} + +post { + url: https://{{host}}/api/v1/flows/{{flow_id}}/execute + body: json + auth: inherit +} + +body:json { +{ + "channel": "api", + "contact": { + "person_name": "Maria da Silva", + "phone_number": "5511999999999" + } +} +} diff --git a/bruno/ClickFlow_Runner/executions/007-inicia-execucao-com-arquivo-runner-files.bru b/bruno/ClickFlow_Runner/executions/007-inicia-execucao-com-arquivo-runner-files.bru new file mode 100644 index 0000000..d17ef41 --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/007-inicia-execucao-com-arquivo-runner-files.bru @@ -0,0 +1,26 @@ +meta { + name: Inicia execução — com arquivo (runner_files) + type: http + seq: 7 +} + +post { + url: https://{{host}}/api/v1/flows/{{flow_id}}/execute + body: json + auth: inherit +} + +body:json { +{ + "contact": { + "person_name": "Maria da Silva", + "phone_number": "5511999999999" + }, + "files": [ + { + "key": "1", + "content_base_64": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKL01lZGlhQm94IFswIDAgNjEyIDc5Ml0KPj4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovUmVzb3VyY2VzIDw8Pj4KL0NvbnRlbnRzIDQgMCBSCj4+CmVuZG9iago0IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihTYW1wbGUpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDUKMDAwMDAwMDAwMCA2NTUzNSBmCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1OCAwMDAwMCBuIAowMDAwMDAwMTE1IDAwMDAwIG4gCjAwMDAwMDAyMDQgMDAwMDAgbiAKMDAwMDAwMDI5MyAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDUKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM4NQolJUVPRgo=" + } + ] +} +} diff --git a/bruno/ClickFlow_Runner/executions/folder.bru b/bruno/ClickFlow_Runner/executions/folder.bru new file mode 100644 index 0000000..c7a4c0c --- /dev/null +++ b/bruno/ClickFlow_Runner/executions/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Executions +} diff --git a/bruno/ClickFlow_Runner/health/001-health-check.bru b/bruno/ClickFlow_Runner/health/001-health-check.bru new file mode 100644 index 0000000..8dcba46 --- /dev/null +++ b/bruno/ClickFlow_Runner/health/001-health-check.bru @@ -0,0 +1,15 @@ +meta { + name: Health check + type: http + seq: 1 +} + +get { + url: https://{{host}}/health + body: none + auth: none +} + +headers { + Content-Type: application/json +} diff --git a/bruno/ClickFlow_Runner/health/folder.bru b/bruno/ClickFlow_Runner/health/folder.bru new file mode 100644 index 0000000..0dba28c --- /dev/null +++ b/bruno/ClickFlow_Runner/health/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Health +} diff --git a/bruno/ClickForm/bruno.json b/bruno/ClickForm/bruno.json new file mode 100644 index 0000000..97556e1 --- /dev/null +++ b/bruno/ClickForm/bruno.json @@ -0,0 +1,9 @@ +{ + "version": "1", + "name": "ClickForm", + "type": "collection", + "ignore": [ + "node_modules", + ".git" + ] +} \ No newline at end of file diff --git a/bruno/ClickForm/collection.bru b/bruno/ClickForm/collection.bru new file mode 100644 index 0000000..4a6ca6e --- /dev/null +++ b/bruno/ClickForm/collection.bru @@ -0,0 +1,9 @@ +auth { + mode: apikey +} + +auth:apikey { + key: Authorization + value: {{access_token}} + placement: header +} diff --git a/bruno/ClickForm/environments/Producao.bru b/bruno/ClickForm/environments/Producao.bru new file mode 100644 index 0000000..c7d7bc2 --- /dev/null +++ b/bruno/ClickForm/environments/Producao.bru @@ -0,0 +1,9 @@ +vars { + host: clickform.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickForm/environments/Sandbox.bru b/bruno/ClickForm/environments/Sandbox.bru new file mode 100644 index 0000000..674e08c --- /dev/null +++ b/bruno/ClickForm/environments/Sandbox.bru @@ -0,0 +1,9 @@ +vars { + host: clickform-sandbox.clicksign.com + access_token: + flow_id: + execution_id: + form_key: + version_key: + run_key: +} diff --git a/bruno/ClickForm/forms/002-lista-todos-os-formularios.bru b/bruno/ClickForm/forms/002-lista-todos-os-formularios.bru new file mode 100644 index 0000000..f3bb2a4 --- /dev/null +++ b/bruno/ClickForm/forms/002-lista-todos-os-formularios.bru @@ -0,0 +1,11 @@ +meta { + name: Lista todos os formulários + type: http + seq: 2 +} + +get { + url: https://{{host}}/api/v1/forms + body: none + auth: inherit +} diff --git a/bruno/ClickForm/forms/003-cria-o-formulario-base.bru b/bruno/ClickForm/forms/003-cria-o-formulario-base.bru new file mode 100644 index 0000000..fd19056 --- /dev/null +++ b/bruno/ClickForm/forms/003-cria-o-formulario-base.bru @@ -0,0 +1,18 @@ +meta { + name: Cria o formulário base + type: http + seq: 3 +} + +post { + url: https://{{host}}/api/v1/forms + body: json + auth: inherit +} + +body:json { +{ + "name": "Cadastro de cliente", + "callback_url": "https://partner.example.com/hooks/clickform" +} +} diff --git a/bruno/ClickForm/forms/004-retorna-metadados-de-um-formulario-especifico.bru b/bruno/ClickForm/forms/004-retorna-metadados-de-um-formulario-especifico.bru new file mode 100644 index 0000000..0596843 --- /dev/null +++ b/bruno/ClickForm/forms/004-retorna-metadados-de-um-formulario-especifico.bru @@ -0,0 +1,11 @@ +meta { + name: Retorna metadados de um formulário específico + type: http + seq: 4 +} + +get { + url: https://{{host}}/api/v1/forms/{{form_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/forms/005-atualiza-os-metadados-do-formulario.bru b/bruno/ClickForm/forms/005-atualiza-os-metadados-do-formulario.bru new file mode 100644 index 0000000..a9ecabe --- /dev/null +++ b/bruno/ClickForm/forms/005-atualiza-os-metadados-do-formulario.bru @@ -0,0 +1,18 @@ +meta { + name: Atualiza os metadados do formulário + type: http + seq: 5 +} + +put { + url: https://{{host}}/api/v1/forms/{{form_key}} + body: json + auth: inherit +} + +body:json { +{ + "name": "Cadastro de cliente — revisão 2", + "callback_url": "https://partner.example.com/hooks/clickform-v2" +} +} diff --git a/bruno/ClickForm/forms/006-remove-um-formulario.bru b/bruno/ClickForm/forms/006-remove-um-formulario.bru new file mode 100644 index 0000000..b460eae --- /dev/null +++ b/bruno/ClickForm/forms/006-remove-um-formulario.bru @@ -0,0 +1,11 @@ +meta { + name: Remove um formulário + type: http + seq: 6 +} + +delete { + url: https://{{host}}/api/v1/forms/{{form_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/forms/folder.bru b/bruno/ClickForm/forms/folder.bru new file mode 100644 index 0000000..cf23781 --- /dev/null +++ b/bruno/ClickForm/forms/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Forms +} diff --git a/bruno/ClickForm/health/001-verifica-disponibilidade-do-servico.bru b/bruno/ClickForm/health/001-verifica-disponibilidade-do-servico.bru new file mode 100644 index 0000000..73fc3e5 --- /dev/null +++ b/bruno/ClickForm/health/001-verifica-disponibilidade-do-servico.bru @@ -0,0 +1,15 @@ +meta { + name: Verifica disponibilidade do serviço + type: http + seq: 1 +} + +get { + url: https://{{host}}/health + body: none + auth: none +} + +headers { + Content-Type: application/json +} diff --git a/bruno/ClickForm/health/folder.bru b/bruno/ClickForm/health/folder.bru new file mode 100644 index 0000000..0dba28c --- /dev/null +++ b/bruno/ClickForm/health/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Health +} diff --git a/bruno/ClickForm/runs/007-lista-todas-as-execucoes-associadas-a-uma-versao.bru b/bruno/ClickForm/runs/007-lista-todas-as-execucoes-associadas-a-uma-versao.bru new file mode 100644 index 0000000..9bd5872 --- /dev/null +++ b/bruno/ClickForm/runs/007-lista-todas-as-execucoes-associadas-a-uma-versao.bru @@ -0,0 +1,11 @@ +meta { + name: Lista todas as execuções associadas a uma versão + type: http + seq: 7 +} + +get { + url: https://{{host}}/api/v1/versions/{{version_key}}/runs + body: none + auth: inherit +} diff --git a/bruno/ClickForm/runs/008-cria-uma-versao-pre-preenchida-do-formulario-para-preenchimento-unico.bru b/bruno/ClickForm/runs/008-cria-uma-versao-pre-preenchida-do-formulario-para-preenchimento-unico.bru new file mode 100644 index 0000000..699518b --- /dev/null +++ b/bruno/ClickForm/runs/008-cria-uma-versao-pre-preenchida-do-formulario-para-preenchimento-unico.bru @@ -0,0 +1,34 @@ +meta { + name: Cria uma versão pré-preenchida do formulário para preenchimento único + type: http + seq: 8 +} + +post { + url: https://{{host}}/api/v1/versions/{{version_key}}/runs + body: json + auth: inherit +} + +body:json { +{ + "callback_url": "https://erp.cliente.com/callback", + "context": { + "nome-completo-59661f5fe933": { + "value": "John Doe", + "read_only": false + }, + "whatsapp-f9c2322fcc74": { + "value": "48999999999", + "read_only": false + }, + "email-6679641e7540": { + "value": "john.doe@developer.com", + "read_only": true + } + }, + "notification": { + "whatsapp": "(11) 9 1234-5678" + } +} +} diff --git a/bruno/ClickForm/runs/009-obtem-uma-execucao-run-por-versao.bru b/bruno/ClickForm/runs/009-obtem-uma-execucao-run-por-versao.bru new file mode 100644 index 0000000..a7a502d --- /dev/null +++ b/bruno/ClickForm/runs/009-obtem-uma-execucao-run-por-versao.bru @@ -0,0 +1,11 @@ +meta { + name: Obtém uma execução (run) por versão + type: http + seq: 9 +} + +get { + url: https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/runs/010-atualiza-contexto-expires-at-ou-callback-url-do-run.bru b/bruno/ClickForm/runs/010-atualiza-contexto-expires-at-ou-callback-url-do-run.bru new file mode 100644 index 0000000..9de0aec --- /dev/null +++ b/bruno/ClickForm/runs/010-atualiza-contexto-expires-at-ou-callback-url-do-run.bru @@ -0,0 +1,32 @@ +meta { + name: Atualiza contexto, expires_at ou callback_url do run + type: http + seq: 10 +} + +put { + url: https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}} + body: json + auth: inherit +} + +body:json { +{ + "context": { + "nome-completo-59661f5fe933": { + "value": "John Doe", + "read_only": false + }, + "whatsapp-f9c2322fcc74": { + "value": "48999999999", + "read_only": false + }, + "email-6679641e7540": { + "value": "john.doe@developer.com", + "read_only": true + } + }, + "expires_at": "2026-12-31T23:59:59Z", + "callback_url": "https://erp.cliente.com/callback" +} +} diff --git a/bruno/ClickForm/runs/011-remove-uma-execucao-pendente.bru b/bruno/ClickForm/runs/011-remove-uma-execucao-pendente.bru new file mode 100644 index 0000000..a697046 --- /dev/null +++ b/bruno/ClickForm/runs/011-remove-uma-execucao-pendente.bru @@ -0,0 +1,11 @@ +meta { + name: Remove uma execução pendente + type: http + seq: 11 +} + +delete { + url: https://{{host}}/api/v1/versions/{{version_key}}/runs/{{run_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/runs/folder.bru b/bruno/ClickForm/runs/folder.bru new file mode 100644 index 0000000..c98da09 --- /dev/null +++ b/bruno/ClickForm/runs/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Runs +} diff --git a/bruno/ClickForm/versions/012-lista-todas-as-versoes-de-um-formulario.bru b/bruno/ClickForm/versions/012-lista-todas-as-versoes-de-um-formulario.bru new file mode 100644 index 0000000..b090098 --- /dev/null +++ b/bruno/ClickForm/versions/012-lista-todas-as-versoes-de-um-formulario.bru @@ -0,0 +1,11 @@ +meta { + name: Lista todas as versões de um formulário + type: http + seq: 12 +} + +get { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: none + auth: inherit +} diff --git a/bruno/ClickForm/versions/013-cria-uma-nova-versao-schema-do-formulario.bru b/bruno/ClickForm/versions/013-cria-uma-nova-versao-schema-do-formulario.bru new file mode 100644 index 0000000..bed0496 --- /dev/null +++ b/bruno/ClickForm/versions/013-cria-uma-nova-versao-schema-do-formulario.bru @@ -0,0 +1,54 @@ +meta { + name: Cria uma nova versão (schema) do formulário + type: http + seq: 13 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações.", + "steps": { + "0": "Informações pessoais", + "1": "Informações de contato" + } + }, + "fields": [ + { + "label": "Nome completo", + "type": "text", + "placeholder": "Maria da Silva", + "help_balloon": "Use o mesmo nome do documento.", + "required": true, + "step": 0, + "order": 1 + }, + { + "label": "Whatsapp", + "type": "phone_number", + "placeholder": "(11) 99999-9999", + "help_balloon": "Inclua o DDD para facilitar o retorno.", + "required": true, + "step": 1 + }, + { + "label": "Email", + "type": "email", + "placeholder": "nome@empresa.com", + "help_balloon": "Informe um e-mail válido para contato.", + "required": true, + "step": 1 + } + ] +} +} diff --git a/bruno/ClickForm/versions/014-retorna-a-estrutura-da-versao.bru b/bruno/ClickForm/versions/014-retorna-a-estrutura-da-versao.bru new file mode 100644 index 0000000..128b9d2 --- /dev/null +++ b/bruno/ClickForm/versions/014-retorna-a-estrutura-da-versao.bru @@ -0,0 +1,11 @@ +meta { + name: Retorna a estrutura da versão + type: http + seq: 14 +} + +get { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/versions/015-atualiza-metadados-da-versao-ex-is-active.bru b/bruno/ClickForm/versions/015-atualiza-metadados-da-versao-ex-is-active.bru new file mode 100644 index 0000000..027e606 --- /dev/null +++ b/bruno/ClickForm/versions/015-atualiza-metadados-da-versao-ex-is-active.bru @@ -0,0 +1,110 @@ +meta { + name: Atualiza metadados da versão (ex.: is_active) + type: http + seq: 15 +} + +put { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}} + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações.", + "steps": { + "0": "Informações pessoais", + "1": "Informações de contato", + "2": "Informações de endereço" + } + }, + "fields": [ + { + "label": "Full name", + "type": "text", + "placeholder": "Type your full name", + "required": true, + "step": 0, + "order": 1 + }, + { + "label": "Email", + "type": "email", + "placeholder": "name@company.com", + "required": true, + "step": 1, + "order": 2 + }, + { + "key": "cep_principal", + "label": "ZIP code", + "type": "cep", + "placeholder": "00000-000", + "required": true, + "step": 2, + "order": 3, + "options": { + "fields": [ + { + "label": "Street address", + "attribute_type": "street", + "required": true + }, + { + "label": "State", + "attribute_type": "state", + "required": true + }, + { + "label": "City", + "attribute_type": "city" + }, + { + "label": "Neighborhood", + "attribute_type": "neighborhood" + }, + { + "label": "Number", + "attribute_type": "number" + }, + { + "label": "Complement", + "attribute_type": "complement" + } + ] + } + }, + { + "label": "Shipping method", + "type": "radio-group", + "placeholder": "Choose a shipping method", + "required": false, + "step": 2, + "order": 6, + "options": { + "other": true, + "values": [ + { + "label": "SEDEX", + "value": "SEDEX" + }, + { + "label": "Retirar presencialmente", + "value": "RETIRAR" + }, + { + "label": "PAC", + "value": "PAC" + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/016-remove-uma-versao-especifica.bru b/bruno/ClickForm/versions/016-remove-uma-versao-especifica.bru new file mode 100644 index 0000000..1cae064 --- /dev/null +++ b/bruno/ClickForm/versions/016-remove-uma-versao-especifica.bru @@ -0,0 +1,11 @@ +meta { + name: Remove uma versão específica + type: http + seq: 16 +} + +delete { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions/{{version_key}} + body: none + auth: inherit +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/017-texto-curto.bru b/bruno/ClickForm/versions/exemplos-de-versoes/017-texto-curto.bru new file mode 100644 index 0000000..36700b8 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/017-texto-curto.bru @@ -0,0 +1,37 @@ +meta { + name: Texto curto + type: http + seq: 17 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Full name", + "type": "text", + "placeholder": "Type your full name", + "help_balloon": "Campo de texto simples com limite de caracteres.", + "required": true, + "order": 1, + "step": 0, + "options": { + "maxlength": 120 + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/018-texto-longo.bru b/bruno/ClickForm/versions/exemplos-de-versoes/018-texto-longo.bru new file mode 100644 index 0000000..6cde81d --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/018-texto-longo.bru @@ -0,0 +1,37 @@ +meta { + name: Texto longo + type: http + seq: 18 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Notes", + "type": "textarea", + "placeholder": "Additional comments or context", + "help_balloon": "Use este campo para textos longos.", + "required": false, + "order": 1, + "step": 0, + "options": { + "maxlength": 2000 + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/019-numero.bru b/bruno/ClickForm/versions/exemplos-de-versoes/019-numero.bru new file mode 100644 index 0000000..931c6de --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/019-numero.bru @@ -0,0 +1,34 @@ +meta { + name: Número + type: http + seq: 19 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Quantity", + "type": "number", + "placeholder": "0", + "help_balloon": "Aceita valores numéricos.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/020-intervalo-numerico.bru b/bruno/ClickForm/versions/exemplos-de-versoes/020-intervalo-numerico.bru new file mode 100644 index 0000000..ce6af60 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/020-intervalo-numerico.bru @@ -0,0 +1,41 @@ +meta { + name: Intervalo numérico + type: http + seq: 20 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Taxa de administração", + "type": "number_range", + "placeholder": "Taxa de administração", + "help_balloon": "Valor numérico com limites mínimo e máximo, casas decimais e mensagens de erro configuráveis.", + "required": false, + "order": 1, + "step": 0, + "options": { + "min_value": 1.2, + "max_value": 4.5, + "decimal_places": 2, + "min_error_message": "Informe um valor a partir de {min_value} com até {decimal_places} casas decimais.", + "max_error_message": "Informe um valor até {max_value} com até {decimal_places} casas decimais." + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/021-e-mail-do-signatario.bru b/bruno/ClickForm/versions/exemplos-de-versoes/021-e-mail-do-signatario.bru new file mode 100644 index 0000000..a20a7dc --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/021-e-mail-do-signatario.bru @@ -0,0 +1,34 @@ +meta { + name: E-mail do signatário + type: http + seq: 21 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Work email", + "type": "email", + "placeholder": "name@company.com", + "help_balloon": "Usaremos este e-mail para notificações.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/022-numero-de-telefone-whatsapp.bru b/bruno/ClickForm/versions/exemplos-de-versoes/022-numero-de-telefone-whatsapp.bru new file mode 100644 index 0000000..d582e02 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/022-numero-de-telefone-whatsapp.bru @@ -0,0 +1,34 @@ +meta { + name: Número de Telefone/Whatsapp + type: http + seq: 22 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Phone number", + "type": "phone_number", + "placeholder": "(11) 98765-4321", + "help_balloon": "Formato com DDD.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/023-data.bru b/bruno/ClickForm/versions/exemplos-de-versoes/023-data.bru new file mode 100644 index 0000000..2f46122 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/023-data.bru @@ -0,0 +1,34 @@ +meta { + name: Data + type: http + seq: 23 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Birth date", + "type": "date", + "placeholder": "DD/MM/YYYY", + "help_balloon": "Informe uma data válida.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/024-cpf.bru b/bruno/ClickForm/versions/exemplos-de-versoes/024-cpf.bru new file mode 100644 index 0000000..810bdfa --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/024-cpf.bru @@ -0,0 +1,34 @@ +meta { + name: CPF + type: http + seq: 24 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Tax ID (CPF)", + "type": "cpf", + "placeholder": "000.000.000-00", + "help_balloon": "Formato esperado de CPF.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/025-cnpj.bru b/bruno/ClickForm/versions/exemplos-de-versoes/025-cnpj.bru new file mode 100644 index 0000000..54aa4d3 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/025-cnpj.bru @@ -0,0 +1,34 @@ +meta { + name: CNPJ + type: http + seq: 25 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Company ID (CNPJ)", + "type": "cnpj", + "placeholder": "00.000.000/0000-00", + "help_balloon": "Formato esperado de CNPJ.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/026-monetario.bru b/bruno/ClickForm/versions/exemplos-de-versoes/026-monetario.bru new file mode 100644 index 0000000..a55a300 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/026-monetario.bru @@ -0,0 +1,34 @@ +meta { + name: Monetário + type: http + seq: 26 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Estimated amount", + "type": "currency", + "placeholder": "0,00", + "help_balloon": "Informe o valor monetário.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/027-cep.bru b/bruno/ClickForm/versions/exemplos-de-versoes/027-cep.bru new file mode 100644 index 0000000..fc4ad28 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/027-cep.bru @@ -0,0 +1,70 @@ +meta { + name: CEP + type: http + seq: 27 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "ZIP code", + "type": "cep", + "placeholder": "00000-000", + "help_balloon": "Informe o CEP; os campos abaixo compõem o endereço.", + "required": true, + "order": 1, + "step": 0, + "options": { + "fields": [ + { + "label": "Street address", + "attribute_type": "street", + "required": true, + "help_balloon": "Preenchido automaticamente quando possível." + }, + { + "label": "State", + "attribute_type": "state", + "required": true, + "help_balloon": "UF do endereço." + }, + { + "label": "City", + "attribute_type": "city", + "help_balloon": "Município correspondente ao CEP." + }, + { + "label": "Neighborhood", + "attribute_type": "neighborhood", + "help_balloon": "Bairro do endereço." + }, + { + "label": "Number", + "attribute_type": "number", + "help_balloon": "Número do imóvel (sem letras)." + }, + { + "label": "Complement", + "attribute_type": "complement", + "help_balloon": "Apartamento, bloco, sala, etc." + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/028-imagem.bru b/bruno/ClickForm/versions/exemplos-de-versoes/028-imagem.bru new file mode 100644 index 0000000..68ffe1d --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/028-imagem.bru @@ -0,0 +1,34 @@ +meta { + name: Imagem + type: http + seq: 28 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Document photo", + "type": "image", + "placeholder": "PNG or JPG", + "help_balloon": "Upload restrito a imagens.", + "required": true, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/029-anexo.bru b/bruno/ClickForm/versions/exemplos-de-versoes/029-anexo.bru new file mode 100644 index 0000000..721d45b --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/029-anexo.bru @@ -0,0 +1,34 @@ +meta { + name: Anexo + type: http + seq: 29 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "PDF attachment", + "type": "file", + "placeholder": "Upload a PDF file", + "help_balloon": "Upload de arquivo genérico (ex.: PDF).", + "required": false, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/030-cabecalho.bru b/bruno/ClickForm/versions/exemplos-de-versoes/030-cabecalho.bru new file mode 100644 index 0000000..d0ba3cd --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/030-cabecalho.bru @@ -0,0 +1,32 @@ +meta { + name: Cabeçalho + type: http + seq: 30 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Personal data", + "type": "header", + "required": false, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/031-paragrafo.bru b/bruno/ClickForm/versions/exemplos-de-versoes/031-paragrafo.bru new file mode 100644 index 0000000..bbc2125 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/031-paragrafo.bru @@ -0,0 +1,32 @@ +meta { + name: Parágrafo + type: http + seq: 31 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Please review the information below carefully.", + "type": "paragraph", + "required": false, + "order": 1, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/032-lista-suspensa.bru b/bruno/ClickForm/versions/exemplos-de-versoes/032-lista-suspensa.bru new file mode 100644 index 0000000..41053c7 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/032-lista-suspensa.bru @@ -0,0 +1,46 @@ +meta { + name: Lista suspensa + type: http + seq: 32 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Marital status", + "type": "select", + "placeholder": "Select an option", + "help_balloon": "Selecione uma opção na lista suspensa.", + "required": true, + "order": 1, + "step": 0, + "options": { + "values": [ + { + "label": "Single", + "value": "S" + }, + { + "label": "Married", + "value": "C" + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/033-unica-resposta.bru b/bruno/ClickForm/versions/exemplos-de-versoes/033-unica-resposta.bru new file mode 100644 index 0000000..c26b6e3 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/033-unica-resposta.bru @@ -0,0 +1,46 @@ +meta { + name: Única resposta + type: http + seq: 33 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Payment method", + "type": "radio-group", + "help_balloon": "Escolha uma única opção.", + "required": true, + "order": 1, + "step": 0, + "options": { + "other": true, + "values": [ + { + "label": "Pix", + "value": "PIX" + }, + { + "label": "Card", + "value": "CARD" + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/034-multiplas-respostas.bru b/bruno/ClickForm/versions/exemplos-de-versoes/034-multiplas-respostas.bru new file mode 100644 index 0000000..42e736b --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/034-multiplas-respostas.bru @@ -0,0 +1,46 @@ +meta { + name: Múltiplas respostas + type: http + seq: 34 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Interests", + "type": "checkbox-group", + "help_balloon": "Selecione uma ou mais opções.", + "required": false, + "order": 1, + "step": 0, + "options": { + "other": true, + "values": [ + { + "label": "Marketing", + "value": "MKT" + }, + { + "label": "Product", + "value": "PROD" + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/035-repetidor-de-campos.bru b/bruno/ClickForm/versions/exemplos-de-versoes/035-repetidor-de-campos.bru new file mode 100644 index 0000000..f24d7e4 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/035-repetidor-de-campos.bru @@ -0,0 +1,48 @@ +meta { + name: Repetidor de campos + type: http + seq: 35 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Dependents", + "type": "repeater", + "placeholder": "Add one row per dependent", + "help_balloon": "Adicione um ou mais blocos de dependentes.", + "required": false, + "order": 1, + "step": 0, + "options": { + "button_label": "Add dependent", + "fields": [ + { + "label": "Name", + "type": "text", + "placeholder": "Dependent full name", + "help_balloon": "Sub-campo text dentro do repeater.", + "key": "dependent_name", + "required": true, + "order": 1 + } + ] + } + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/036-campos-com-regras-condicionais.bru b/bruno/ClickForm/versions/exemplos-de-versoes/036-campos-com-regras-condicionais.bru new file mode 100644 index 0000000..3eaa761 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/036-campos-com-regras-condicionais.bru @@ -0,0 +1,65 @@ +meta { + name: Campos com regras condicionais + type: http + seq: 36 +} + +post { + url: https://{{host}}/api/v1/forms/{{form_key}}/versions + body: json + auth: inherit +} + +body:json { +{ + "settings": { + "title": "Atualização de contato", + "subtitle": "Por favor, confirme os dados de contato.", + "finish_title": "Atualização de dados concluída!", + "finish_subtitle": "Em breve nossa equipe entrará em contato.", + "finish_info": "Visite nosso site para mais informações." + }, + "fields": [ + { + "label": "Plan", + "type": "select", + "placeholder": "Choose your plan", + "help_balloon": "A seleção pode exibir ou ocultar outros campos.", + "required": true, + "order": 1, + "step": 0, + "options": { + "values": [ + { + "label": "Full", + "value": "FULL" + }, + { + "label": "Basic", + "value": "BASIC" + } + ] + }, + "conditions": [ + { + "action": "show", + "operator": "equal", + "fields": [ + "Plan details" + ], + "value": "FULL" + } + ] + }, + { + "label": "Plan details", + "type": "text", + "placeholder": "Describe coverage needs", + "help_balloon": "Exibido quando o plano selecionado for \"Full\".", + "required": false, + "order": 2, + "step": 0 + } + ] +} +} diff --git a/bruno/ClickForm/versions/exemplos-de-versoes/folder.bru b/bruno/ClickForm/versions/exemplos-de-versoes/folder.bru new file mode 100644 index 0000000..7222dd1 --- /dev/null +++ b/bruno/ClickForm/versions/exemplos-de-versoes/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Exemplos de versões +} diff --git a/bruno/ClickForm/versions/folder.bru b/bruno/ClickForm/versions/folder.bru new file mode 100644 index 0000000..81e1893 --- /dev/null +++ b/bruno/ClickForm/versions/folder.bru @@ -0,0 +1,3 @@ +meta { + name: Versions +}