Meplato Store API for .NET

This is the .NET client for the Meplato Store API. It consists of a library to integrate your infrastructure with Meplato suite for suppliers.

Prerequisites

You need three things to use the Meplato Store API.

1. A login to Meplato Store.
2. An API token.
3. Microsoft Visual Studio (at least VS 2019) and .NET 4.7.2.

Get your login by contacting Meplato Supplier Network Services. The API token is required to securely communicate with the Meplato Store API. You can find it in the personalization section when logged into Meplato Store.

Installation

1. Open the solution in .\src\Meplato.Store2.sln.
2. Build the solution.

Using the library

We have recently added Meplato.Store2 to the NuGet package management system. So you can very easily add support for Meplato Store API by opening NuGet packages for your project, search for Meplato and add the Meplato.Store2 dependency to your project. Once you have that, this simple program will list the number of catalogs in your account (replace <your-api-token> with the API token you can access in Store):

using System;
using System.Threading.Tasks;
using Meplato.Store2;
using Service = Meplato.Store2.Catalogs.Service;

namespace MeplatoStoreConsole
{
    internal class Program
    {
        private static async Task Main(string[] args)
        {
            var client = new Client();
            var catalogs = new Service(client) {
                User = "<your-api-token>"
            };
            var resp = await catalogs.Search().Do();
            Console.WriteLine($"Found {resp.TotalItems} catalogs");
        }
    }
}

All functionality of the Meplato Store API is separated into services. So you e.g. have a service to work with catalogs, another service to work with products in a catalog etc. All services need to be initialized with your API token. Here's an example:

using Meplato.Store2.Catalogs;

// Client is used to perform HTTP requests.
// The library comes with a default HTTP client,
// but you can build or use your own.
var client = new Meplato.Store2.Client();

// Create and initialize the Catalogs service with your API token.
var service = new Service(client) {
    User = "<your-api-token>"
};

// Get the first 10 of your catalogs, sorted by creation date (descending), then by name.
var response = await service.Search().Skip(0).Take(10).Sort("-created,name").Do();
Console.WriteLine("You have {0} catalog(s).", response.TotalItems);
foreach (var catalog in response.Items)
{
    Console.WriteLine("Catalog with ID={0} has name {1}", catalog.Id, catalog.Name);
}

You should use e.g. Polly to make your API consumer resilient against network errors or API rate limits.

Notice that Polly is much more versatile than this simple snippet; read up the documentation and examples.

The following snippet can also be found in PollyClientTests.cs as executable code:

// Client is used to perform HTTP requests.
// The library comes with a default HTTP client,
// but you can build or use your own.
var client = new Meplato.Store2.Client();

// Create and initialize the Catalogs service with your API token.
var service = new Service(client) {
    User = "<your-api-token>"
};

// Configure a Polly policy that handles exceptions with
// HTTP requests and automatically retries up to 5 times,
// waiting 0.1s at the 1st run, 0.2s at the 2nd, 0.4s at
// the 3rd etc. (exponential backoff).
var retries = 0;
var policy = Policy.Handle<Exception>().WaitAndRetryAsync(
    5,
    attempt => TimeSpan.FromSeconds(0.1 * Math.Pow(2, attempt)),
    (exception, waitTime) =>
    {
        /*
        Assert.NotNull(exception);
        Assert.IsInstanceOf<ServiceException>(exception);
        Assert.AreEqual("Too many requests", exception.Message);
        */
        retries++;

        Console.WriteLine($"Retry {retries} with a wait time of {waitTime}");
    }
);

// Get the first 10 of your catalogs, sorted by creation date (descending), then by name.
try {
    await policy.ExecuteAsync(async () => {
        var response = await service.Search().Skip(0).Take(10).Sort("-created,name").Do();
        Console.WriteLine("You have {0} catalog(s).", response.TotalItems);
        foreach (var catalog in response.Items)
        {
            Console.WriteLine("Catalog with ID={0} has name {1}", catalog.Id, catalog.Name);
        }
    });
}
catch (ServiceException ex) {
    // After 5 retries and still failing, you'll be landing here
    Console.WriteLine($"Request failed with HTTP status {ex.StatusCode}");
}
catch (Exception ex) {
    // Something else went wrong.
}

Feel free to read the unit tests for the various usage scenarios of the library.

Documentation

Complete documentation for the Meplato Store API can be found at https://developer.meplato.com/store2.

Testing

Run the NUnit tests in the Visual Studio solution.

License

This software is licensed under the Apache 2 license.

Copyright (c) 2015 Meplato GmbH <http://www.meplato.com>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.