Vestige API Documentation

gRPC Service Description

The Vestige API offers a comprehensive suite of gRPC service calls, including:

• GetAssets: Retrieves a list of all assets, including their respective ID and name.
• GetAssetStatuses: Fetches the latest status of an asset, such as:
  • Odometer reading (km)
  • Ignition status
  • Location
  • Engine "on" duration (hour)
  • Engine battery level (volt)
• GetAssetExtendedProperties: Provides access to extended properties of an asset, such as:
  • Asset.Details.Vin
  • Asset.Details.Year
  • Asset.Details.Make
  • Asset.Details.Model
  • Asset.Details.Color

For detailed information, refer to the service's proto file.

Getting Started with gRPC Service

For general information on gRPC, visit grpc.io.

The Vestige API service is accessible at grpcServerUrl.

Postman offers excellent support for testing and exploring gRPC services.

To consume the gRPC service in your application

1. Generate proto file via gRPC reflection:

   dotnet grpc-cli dump grpcServerUrl vestige.api.v1.ApiService -o ./VestigeApi

2. Once you have obtained the proto file, generate a strongly-typed client for your programming language following the instructions on the gRPC website.

Authorization

To obtain an access token, use the following cURL command:

curl --request POST \
  --url https://auth.transit-technologies.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"APPLICATION_CLIENT_ID","client_secret":"APPLICATION_CLIENT_SECRET","audience":"https://vestigeview.app/api","grant_type":"client_credentials"}'
    

Use Bearer authentication for subsequent requests.

References

• Generate proto file from gRPC reflection: GitHub
• Google Protocol Buffers documentation: developers.google.com
• Test tools: GitHub
• Postman support: Postman Blog

gRPC for .NET

• gRPC reflection for .NET: DotNet gRPC reflection