Client Setup
The NexudusApiClient is the central object you use to interact with the Nexudus API. It requires an HttpClient, an authentication provider, and an optional configuration object.
Basic setup
Configuration options
Pass a NexudusOptions object to customise the client behaviour:
Using environment variables
For scripts and CI/CD pipelines, store credentials in environment variables instead of hard-coding them:
Set the variables before running your app:
Never commit credentials to source control. Use environment variables, user secrets, or a vault for production deployments.
Entity endpoints
Once you have a client, create endpoint instances for the entities you need:
There are 200+ endpoint classes available — one for every entity type in the Nexudus API. They all expose the same set of methods described in the following pages.