Episerver ServiceAPI: Create a custom endpoint


In some cases, you uploaded an asset through Service API.
And then you want to update its properties later. You can create a custom endpoint to implement it and we want to reuse the authentication, routing  of ServiceAPI:
using EPiServer.ServiceApi.Configuration;
using EPiServer.ServiceApi.Validation;
using EPiServer.ServiceApi.Commerce.Controllers.Catalog;
using ControllerBase = EPiServer.ServiceApi.Commerce.Controllers.Catalog.ControllerBase;
using AuthorizePermissionAttribute = EPiServer.ServiceApi.Configuration.AuthorizePermissionAttribute;
using EPiServer.ServiceApi.Commerce;
using Foundation.Features.Media;
using EPiServer.DataAccess;
using EPiServer.Security;
using System.Configuration.Provider;

namespace Foundation.Custom
{
    [Route("episerverapi/commerce")]
    [RequireHttpsOrClose]
    [ValidateReadOnlyMode(AllowedVerbs = HttpVerbs.Get)]
    [ExceptionHandling]
    [RequestLogging]
    [Authorize(Policy = "ServiceApiAuthorizationPolicy")]
    public class ItemAssetController : ControllerBase
    {
        private readonly IdentityMappingService _identityMappingService;
        private readonly ReferenceConverter _referenceConverter;
        private readonly IContentRepository _contentRepository;

        public ItemAssetController(
            IdentityMappingService identityMappingService,
            ReferenceConverter referenceConverter,
            IContentRepository contentRepository,
            IContentLoader contentLoader,
            IContentVersionRepository contentVersionRepository) : base(contentLoader, contentVersionRepository)
        {
            _identityMappingService = identityMappingService;
            _referenceConverter = referenceConverter;
            _contentRepository = contentRepository;
        }

        [Route("entries/{entryCode}/assets/{assetKey:guid}/properties/categories", Name = "SetAssetCategoriesByEntry")]
        [HttpPut]
        [AuthorizePermission("EPiServerServiceApi", "WriteAccess")]
        public virtual IActionResult SetAssetCategoriesByEntry([FromEntryCode("entryCode")] string entryCode, Guid assetKey, [FromBody] string[] categories)
        {
            var mappedIdentity = _identityMappingService.Get(assetKey);
            //mappedIdentity = _identityMappingService.Get(MappedIdentity.ConstructExternalIdentifier(providerName, integrationId));

            if (mappedIdentity == null)
                return NotFound($"No mapping found for asset with ID {assetKey} on entry {entryCode}");

            var contentLink = _referenceConverter.GetContentLink(entryCode);

            var entryContentBase = _contentLoader.Get<EntryContentBase>(contentLink);

            var commerceMedia =
                entryContentBase.CommerceMediaCollection.FirstOrDefault(media => media.AssetLink.ID == mappedIdentity.ContentLink.ID);

            if (commerceMedia == null || !_contentRepository.TryGet<ImageMediaData>(commerceMedia.AssetLink, out var genericMedia))
                return NotFound();

            genericMedia = (ImageMediaData) genericMedia.CreateWritableClone();
            genericMedia.ImageCategories = categories;

            _contentRepository.Save(genericMedia, SaveAction.Publish, AccessLevel.NoAccess);

            return Ok();
        }
    }
}


For the background, you could look at the table tblMappedIdentity, we can retrieve the content link from asset key (or integrationId):



Time to test our API, I prefer to use the CURL format that can be imported to postman:
curl --location --request PUT 'https://localhost:5001/episerverapi/commerce/entries/P-39813617/assets/24D74AD3-4E22-4AD3-9AD5-A88153DE2CA5/properties/categories' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer {token}' \
--header 'Accept: application/json' \
--header 'Cookie: EPiServer_Commerce_AnonymousId=c6e42968-1bfc-4310-af77-2ca9e4af5eed; EPiStateMarker=true; Language=en' \
--data ' ["cat1", "cat2"]'



If you don't know how to get a token, please refer to this post: https://khanhpham2411.blogspot.com/2023/12/serviceapi-example-of-how-to-properly.html

For the idea of next endpoint,  you can use the provider name and intergrationId.


Comments

Post a Comment

Popular posts from this blog

Optimizely Content Graph: minimal setup for testing

Image
 1. Create a test page: [ContentType(DisplayName = "Test Page", GUID = "462d1812-7385-42c3-8073-c1b7481e7b21", Description = "TestPage", AvailableInEditMode = true, GroupName = GroupNames.Content)] public class TestPage : PageData { [CultureSpecific] [UIHint(UIHint.Textarea)] [Display(Name = "Test", GroupName = SystemTabNames.Content, Order = 1)] public virtual string Test { get; set; } } 2. Add this in Startup services.AddContentGraph(configureOptions: options => { options.SynchronizationEnabled = false; options.Include.ContentTypes = new string[] { typeof(TestPage).Name, }; options.OnlySyncContentTypesInWhitelistToSchema = true; options.ContentVersionSyncMode = Optimizely.ContentGraph.Cms.Configuration.ContentVersionSyncMode.PublishedOnly; }); 3. Create a test page in UI    4. Run the index job again {      "took": 0,  ...
Read more

Episerver ServiceAPI: Example of how-to properly call the media upload

Image
For the example of how-to properly call the media upload, you can refer to my Postman collection: https://github.com/KhanhPham2411/EpiserverAPI_PostmanCollection/blob/main/ServiceAPI/ServiceAPI_Collections.json   For the detail steps: Copy the raw content to Postman: https://raw.githubusercontent.com/KhanhPham2411/EpiserverAPI_PostmanCollection/main/ServiceAPI/ServiceAPI_Collections.json   2. Get ServiceAPI NetCore Token   3. Post to Assets/Import Example media file: https://github.com/KhanhPham2411/EpiserverAPI_PostmanCollection/blob/main/ServiceAPI/01-CreateMediaWithBlob.zip 4. To verify your import is working, use that task id to get task log:      
Read more

SameSite Cookie login troubleshooting

Image
  We will use network tab to capture redirect request when logging in to found the root cause F12 to open developer console and switch to Network tab Login to the Commerce Manger site => We would focus on the request that has Status 302 and Initiator CommerceManager.aspx Click on that request and switch to Cookies tab => Response Cookie is  yellow  mean it has been blocked and that is why it keep showing you the login page 🙂 Obviously, as it's blocked, no cookies have been used for the next request So how do we resolve it, we saw 2 exclamation mark in columns Secure and SamesSite, just  hover  on it and there will be a  hint  to solve :v When hover on SameSite exclamation mark, there will be a message "This Set-Cookie didn't specify a "SameSite" attribute and was defaulted to "SameSite=Lax", and was blocked because it came from a cross-site response which was not the response to top-level navigation. The Set-Cookie had to have been set with ...
Read more