1 min read

.NET SDK

The Poq Backend SDK enables our professional services team and external developers to build the backend of Poq apps as described in this pattern.

It is a collection of .NET libraries that:

  • Enable external developers to integrate to Poq Backend.
  • Enable external developers to host the backend for an app by way of implementing a backend-for-a-client (BFC) and optionally hosting it in their cloud.
  • Reduce the backend implementation effort for internal & external developers by:
    • Providing the platform contracts and utility libraries out-of-the-box.
    • Providing HTTP clients to speak to Poq Backend.

Please check the Backend-For-Client Guidelines to learn how to enable and use it to implement a Poq Backend-For-Client API.

Libraries

Poq

  • Contains all of the platform contracts such as Product, Cart, User.
  • Provides HTTP clients to make requests to Poq platform APIs e.g. ProductClient, CheckoutClient

Poq.Extensions

  • Contains .NET extension methods for commonly used functionality or boiler-plate code.

Poq.WebApi

  • Contains .NET Core WebApi specific code to enable the implementation of a backend-for-a-frontend.
  • Provides functionality for proxying platform requests to Poq Backend and allows for flexibility to customize existing or add new endpoints as required.

Poq.Sfcc

  • Contains HTTP Clients that provide methods to communicate to SFCC endpoints.
  • Allows for customisation of requests and parsing custom responses.

Versioning

The SDKs use semantic versioning i.e. major.minor.revision.

Major: Library contains major features or breaking changes.

Minor: Library contains minor features and non-breaking changes.

Revision: Library does not contain any new features that are visible to the consumers but it may have other changes such as bug fixes, performance improvements or documentation.