Enterspeed.Source.Sdk 2.0.1-alpha.3

Enterspeed .NET SDK ·

Installation

With .NET CLI

dotnet add package Enterspeed.Source.Sdk --version <version>

With Package Manager

Install-Package Enterspeed.Source.Sdk -Version <version>

Getting started

1) Register services

Register required services by calling the AddEnterspeedIngestService extension method and provide your API key.

using Enterspeed.Source.Sdk.Extensions.Setup;

serviceCollection.AddEnterspeedIngestService(new EnterspeedConfiguration
{
    ApiKey = "source-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
});

2) Create entity models

Create entity classes for your models by implementing the IEnterspeedEntity interface or inheriting from EnterspeedEntity class or simply just use the EnterspeedEntity class directly.

using Enterspeed.Source.Sdk.Api.Models;

public class ProductEntity : EnterspeedEntity
{
    public ProductEntity(string id)
    {
        Id = id;
        Type = "product";
    }
}

3) Ingest data

Use the IEnterspeedIngestService to ingest your entities into Enterspeed.

using Enterspeed.Source.Sdk.Api.Models;
using Enterspeed.Source.Sdk.Api.Services;

public class IngestService
{
    private readonly IEnterspeedIngestService _enterspeedIngestService;

    public IngestService(IEnterspeedIngestService enterspeedIngestService)
    {
        _enterspeedIngestService = enterspeedIngestService;
    }

    public void Ingest(IEnterspeedEntity enterspeedEntity)
    {
        _enterspeedIngestService.Save(enterspeedEntity);
    }
}

Documentation

If you need more in depth details, please look through our documentation:
Enterspeed Source SDK documentation

Changelog

See new features, fixes and breaking changes in the Changelog.

Contributing

Pull requests are very welcome.
Please fork this repository and make a PR when you are ready.

Otherwise you are welcome to open an Issue in our issue tracker.

License

Enterspeed .NET SDK is MIT licensed