cpSpatial.Client 1.0.2

cpSpatial.Client

A lightweight .NET client library for calling the cpSpatial API (default: https://spatial.civilpro.com) using strongly-typed contracts from cpSpatial.Contracts.

This package:

• Handles Bearer token acquisition via POST /auth/GetToken
• Caches and refreshes tokens automatically (with a safety skew)
• Exposes typed client methods (e.g. ListSurfacesAsync(projectGuid))

Contracts (DTOs/requests/responses) live in cpSpatial.Contracts.
Client behavior (HTTP, auth, DI registration) lives in cpSpatial.Client.

Install

dotnet add package cpSpatial.Client

You will also need:

dotnet add package Microsoft.Extensions.Http
dotnet add package Microsoft.Extensions.Options.ConfigurationExtensions

Quick start (DI)

appsettings.json

{
  "CpSpatial": {
    "BaseUrl": "https://spatial.civilpro.com",
    "TokenPath": "/auth/GetToken",
    "ClientId": "00000000-0000-0000-0000-000000000000",
    "SecretKey": "REPLACE_WITH_SECRET"
  }
}

Program.cs

using cpSpatial.Client;

builder.Services.AddCpSpatialClient(builder.Configuration, sectionName: "CpSpatial");

Call the client

using cpSpatial.Client;

public sealed class MyService
{
    private readonly ICpSpatialClient _spatial;

    public MyService(ICpSpatialClient spatial)
    {
        _spatial = spatial;
    }

    public async Task DoSomethingAsync(Guid projectGuid, CancellationToken ct)
    {
        var surfaces = await _spatial.ListSurfacesAsync(projectGuid, ct);
        // ...
    }
}

Configuration fields

• BaseUrl (required): Base host of the Spatial API (e.g. https://spatial.civilpro.com)
• TokenPath (required): Token endpoint path (e.g. /auth/GetToken)
• ClientId (required): GUID client identifier
• SecretKey (required): client secret

Optional (if you add them to the options type):

• RefreshSkewSeconds: refresh a little before expiry (default 60)
• TokenRequestTimeoutSeconds: token request timeout seconds (default 15)
• DefaultTokenTtlMinutes: used if token response has no expires_in (default 10)

Notes on contracts layout

Recommended project dependency direction:

cpSpatial.Contracts
        ▲
        │
cpSpatial.Client
        ▲
        │
Host apps (CivilPro API, WinForms, workers)

DTO naming:

• Prefer PascalCase C# properties plus [JsonPropertyName] for snake_case JSON fields.

License

Internal / proprietary