sdksio.DataAndReportingSDK 1.1.0

dotnet add package sdksio.DataAndReportingSDK --version 1.1.0                
NuGet\Install-Package sdksio.DataAndReportingSDK -Version 1.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="sdksio.DataAndReportingSDK" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add sdksio.DataAndReportingSDK --version 1.1.0                
#r "nuget: sdksio.DataAndReportingSDK, 1.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install sdksio.DataAndReportingSDK as a Cake Addin
#addin nuget:?package=sdksio.DataAndReportingSDK&version=1.1.0

// Install sdksio.DataAndReportingSDK as a Cake Tool
#tool nuget:?package=sdksio.DataAndReportingSDK&version=1.1.0                

Getting Started with Shell Data & Reporting APIs

Introduction

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication in Version 2 end points. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. All resources are located in the Shell Card Platform. The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources. All endpoints use the POST verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.

Go to the Shell Developer Portal: https://developer.shell.com

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package sdksio.DataAndReportingSDK --version 1.1.0

You can also view the package at: https://www.nuget.org/packages/sdksio.DataAndReportingSDK/1.1.0

Test the SDK

The generated SDK also contain one or more Tests, which are contained in the Tests project. In order to invoke these test cases, you will need NUnit 3.0 Test Adapter Extension for Visual Studio. Once the SDK is complied, the test cases should appear in the Test Explorer window. Here, you can click Run All to execute these test cases.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
Environment Environment The API environment. <br> Default: Environment.SIT
Timeout TimeSpan Http client timeout.<br>Default: TimeSpan.FromSeconds(100)
BasicAuthCredentials BasicAuthCredentials The Credentials Setter for Basic Authentication
BearerTokenCredentials BearerTokenCredentials The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

ShellDataReportingAPIsClient client = new ShellDataReportingAPIsClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "Username",
            "Password"
        )
        .Build())
    .BearerTokenCredentials(
        new BearerTokenModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .Build())
    .Environment(ShellDataReportingAPIs.Standard.Environment.SIT)
    .Build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
SIT Default
Production -

Authorization

This API uses the following authentication schemes.

List of APIs

Classes Documentation

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 83 9/20/2024
1.0.0 107 5/28/2024