OrbApiamticSDK 0.0.1

Getting Started with API Reference

Introduction

Orb's API is built with the following principles in mind:

1. Predictable developer experience: Where applicable, the Orb API uses industry-standard patterns such as cursor-based pagination and standardized error output. To help with debugging in critical API actions, the API always strives to provide detailed and actionable error messages. Aliases such as external customer IDs aid in fast integration times.
2. Reliably real time: Orb's event-based APIs, such as event ingestion are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event-level credits ledger and a highly performant webhooks architecture.
3. Flexibility at the forefront: Features like timezone localization and the ability to amend historical usage show the flexible nature of the platform.

You can download the latest OpenAPI spec here - pass ?version=3.0 for an OpenAPI 3.0-compatible spec.

Install the Package

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

dotnet add package OrbApiamticSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/OrbApiamticSDK/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using ApiReference.Standard;
using ApiReference.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

ApiReferenceClient client = new ApiReferenceClient.Builder()
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using ApiReference.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = ApiReferenceClient
    .FromConfiguration(configuration.GetSection("ApiReference"));

See the Configuration-Based Initialization section for details.

Authorization

This API uses the following authentication schemes.

• APIKeyAuth (OAuth 2 Bearer token)

List of APIs

• Creditnote
• Dimensional Price Group
• Priceinterval
• Subscription Change
• Alert
• Availability
• Coupon
• Credit
• Customer
• Event
• Invoice
• Item
• License
• License Type
• Metric
• Plan
• Price
• Subscription

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter