V14: Integrations (ActiveCampaign/Forms)

- Implement management api for Active Campaign

Author: dtng95

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignComposer.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
-
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
 using Umbraco.Cms.Core.Composing;
 using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Forms.Core.Providers;
@@ -30,6 +31,21 @@ public void Compose(IUmbracoBuilder builder)
 
             builder.Services.AddSingleton<IAccountService, AccountService>();
             builder.Services.AddSingleton<IContactService, ContactService>();
+
+            // Generate Swagger documentation for Zapier API
+            builder.Services.Configure<SwaggerGenOptions>(options =>
+            {
+                options.SwaggerDoc(
+                    Constants.ManagementApi.ApiName,
+                    new OpenApiInfo
+                    {
+                        Title = Constants.ManagementApi.ApiTitle,
+                        Version = "Latest",
+                        Description = $"Describes the {Constants.ManagementApi.ApiTitle} available for handling Active Campaign automation and configuration."
+                    });
+
+                options.CustomOperationIds(e => $"{e.ActionDescriptor.RouteValues["action"]}");
+            });
         }
     }
 }

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/ActiveCampaignContactsWorkflow.cs

@@ -2,7 +2,6 @@
 using Microsoft.Extensions.Options;
 
 using System.Text.Json;
-
 using Umbraco.Forms.Core;
 using Umbraco.Forms.Core.Enums;
 using Umbraco.Forms.Core.Persistence.Dtos;
@@ -55,7 +54,7 @@ public ActiveCampaignContactsWorkflow(IOptions<ActiveCampaignSettings> options,
             _logger = logger;
         }
 
-        public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context)
+        public override async Task<WorkflowExecutionStatus> ExecuteAsync(WorkflowExecutionContext context)
         {
             try
             {
@@ -71,7 +70,7 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                 {
                     _logger.LogInformation("Contact already exists in ActiveCampaign and workflow is configured to not apply updates, so update of information was skipped.");
 
-                    return WorkflowExecutionStatus.Completed;
+                    return await Task.FromResult<WorkflowExecutionStatus>(WorkflowExecutionStatus.Completed);
                 }
 
                 var requestDto = new ContactDetailDto { Contact = Build(context.Record) };
@@ -97,7 +96,7 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                 {
                     _logger.LogError($"Failed to create/update contact: {email}");
 
-                    return WorkflowExecutionStatus.Failed;
+                    return await Task.FromResult<WorkflowExecutionStatus>(WorkflowExecutionStatus.Failed);
                 }
 
                 // Associate contact with account if last one is specified.
@@ -107,13 +106,13 @@ public override WorkflowExecutionStatus Execute(WorkflowExecutionContext context
                         .ConfigureAwait(false).GetAwaiter().GetResult();
                 }
 
-                return WorkflowExecutionStatus.Completed;
+                return await Task.FromResult<WorkflowExecutionStatus>(WorkflowExecutionStatus.Completed);
             }
             catch(Exception ex)
             {
                 _logger.LogError(ex, ex.Message);
 
-                return WorkflowExecutionStatus.Failed;
+                return await Task.FromResult<WorkflowExecutionStatus>(WorkflowExecutionStatus.Failed);
             }
         }
 

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/AccountControllerBase.cs

@@ -1,12 +1,25 @@
-using System;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
 
 namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts
 {
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/accounts")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.AccountsGroupName)]
     public class AccountControllerBase : ActiveCampaingControllerBase
     {
+        protected readonly IAccountService _accountService;
+
+        public AccountControllerBase(IAccountService accountService)
+        {
+            _accountService = accountService;
+        }
     }
 }

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Accounts/GetAccountController.cs

@@ -0,0 +1,28 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Accounts
+{
+    public class GetAccountController : AccountControllerBase
+    {
+        public GetAccountController(IAccountService accountService) : base(accountService)
+        {
+        }
+
+        [HttpGet]
+        [ProducesResponseType(typeof(AccountCollectionResponseDto), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetAccounts()
+        {
+            var accounts = await _accountService.Get();
+
+            return Ok(new JsonResult(accounts));
+        }
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/CheckApiAccessController.cs

@@ -0,0 +1,25 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    public class CheckApiAccessController : ContactControllerBase
+    {
+        public CheckApiAccessController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
+        {
+        }
+
+        [HttpGet("api-access")]
+        [ProducesResponseType(typeof(ApiAccessDto), StatusCodes.Status200OK)]
+        public IActionResult CheckApiAccess() => Ok(new JsonResult(new ApiAccessDto(_settings.BaseUrl, _settings.ApiKey)));
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/ContactControllerBase.cs

@@ -1,12 +1,31 @@
-using System;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
 
 namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
 {
+    [ApiVersion("1.0")]
+    [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/contacts")]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.ContactGroupName)]
     public class ContactControllerBase : ActiveCampaingControllerBase
     {
+        protected readonly ActiveCampaignSettings _settings;
+
+        protected readonly IContactService _contactService;
+
+        public ContactControllerBase(IOptions<ActiveCampaignSettings> options, IContactService contactService)
+        {
+            _settings = options.Value;
+
+            _contactService = contactService;
+        }
     }
 }

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetContactFieldsController.cs

@@ -0,0 +1,25 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    public class GetContactFieldsController : ContactControllerBase
+    {
+        public GetContactFieldsController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
+        {
+        }
+
+        [HttpGet("fields")]
+        [ProducesResponseType(typeof(List<ContactFieldSettings>), StatusCodes.Status200OK)]
+        public IActionResult GetContactFields() => Ok(new JsonResult(_settings.ContactFields));
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Api/Management/Controllers/Contacts/GetCustomFieldsController.cs

@@ -0,0 +1,26 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Configuration;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Models.Dtos;
+using Umbraco.Forms.Integrations.Crm.ActiveCampaign.Services;
+
+namespace Umbraco.Forms.Integrations.Crm.ActiveCampaign.Api.Management.Controllers.Contacts
+{
+    public class GetCustomFieldsController : ContactControllerBase
+    {
+        public GetCustomFieldsController(IOptions<ActiveCampaignSettings> options, IContactService contactService) : base(options, contactService)
+        {
+        }
+
+        [HttpGet("custom")]
+        [ProducesResponseType(typeof(CustomFieldCollectionResponseDto), StatusCodes.Status200OK)]
+        public IActionResult GetCustomFields() =>
+            Ok(new JsonResult(_contactService.GetCustomFields().ConfigureAwait(false).GetAwaiter().GetResult()));
+    }
+}

src/Umbraco.Forms.Integrations.Crm.ActiveCampaign/Constants.cs

@@ -8,5 +8,17 @@ public class Constants
         public const string SettingsPath = "Umbraco:Forms:Integrations:Crm:ActiveCampaign:Settings";
 
         public const string HttpClient = "ActiveCampaignClient";
+
+        public static class ManagementApi
+        {
+            public const string RootPath = "active-campaign/management/api";
+
+            public const string ApiName = "active-campaign-management";
+
+            public const string ApiTitle = "Active Campaign Management API";
+
+            public const string ContactGroupName = "Contacts";
+            public const string AccountsGroupName = "Accounts";
+        }
     }
 }