EncompassRest
Encompass API Client Library for .NET Framework 4.5+ and .NET Standard 1.1+.
Why does this exist?
You may wonder why this library exists when Ellie Mae has provided their own Encompass API .NET Language Bindings.
First, the Encompass API .NET Language Bindings were released long after the API's became available so users needed a common .NET library for consuming the Encompass API's, hence this library was born.
Second, the swagger generated Encompass API .NET Language Bindings are less robust compared to the custom crafted, well thought-out, and thoroughly tested EncompassRest library.
More features
- Field ID support
- Dirty checking serialization to only send back the updated data
- Option to auto retrieve new token and resend the request when using an expired token
- Option to auto resend the request on server timeouts
- Raw API calls support
- Ability to assign and retrieve string properties as enum values to reduce the need of magic strings
- .NET Standard support
- Extension data support, for when Ellie Mae adds properties to the returned json objects but the library isn't updated yet
-
CancellationToken
support - Properties are lazily created upon gets so you don't need to new them up first to use them
-
INotifyPropertyChanged
support - Uses
decimal
instead ofdouble
to prevent precision loss
Simpler
- More convenient interface with a single defined entry point, the
EncompassRestClient
object which is the equivalent of theSession
object in the SDK - Simpler Type names, e.g.
UCDDetail
instead ofLoanContractClosingCostClosingDisclosure3UCDDetails
- Single NuGet package
- No configuration files
- Publicly exposes only relevant .NET API
Optimized for performance
- Serializes directly to output
Stream
meaning no string allocation - Reuses one
JsonSerializer
instance so it's cache isn't needed to be repopulated on each request -
HttpClient
is in general more performant overRestSharp
Getting started
- Install the EncompassRest Nuget package.
- Create an async method in your consuming code.
-
Create an
EncompassRestClient
object. -
Use
EncompassRestClient
object to make API calls.
Create an async method
EncompassRest is a fully asynchronous library meaning all of it's Encompass API calls are made asynchronously to allow great performance for maximum throughput. To get started using the library you need to create an async
method. To avoid deadlocks with async code it is recommended you DO NOT use Task.Result
or the Task.Wait
methods and instead implement async
all the way from the top, e.g. Main
or your Controller
s actions.
Web apps:
public async Task<IActionResult> GetAsync()
{
// Your async code goes here
}
Console apps:
For C#7.1 and up you should use an async Main
method like so.
public async Task Main()
{
// Your async code goes here
}
For C#7 and below you should use Task.Run
inside of Main
to use async methods.
public void Main()
{
Task.Run(async () => {
// Your async code goes here
}).GetAwaiter().GetResult();
}
EncompassRestClient
object
Create an The EncompassRestClient
class implements IDisposable
so it is recommended to use a using
statement to automatically dispose of the object.
From user credentials which auto-retrieves new token when expired
using (var client = await EncompassRestClient.CreateAsync(
new ClientParameters("apiClientId", "apiClientSecret"),
tokenCreator => tokenCreator.FromUserCredentialsAsync("encompassInstanceId", "encompassUserId", "encompassPassword")))
{
// use client
}
From authorization code
using (var client = await EncompassRestClient.CreateFromAuthorizationCodeAsync(
new ClientParameters("apiClientId", "apiClientSecret"), "redirectUri", "authorizationCode"))
{
// use client
}
From access token
using (var client = await EncompassRestClient.CreateFromAccessTokenAsync(
new ClientParameters("apiClientId", "apiClientSecret"), "accessToken"))
{
// use client
}
EncompassRestClient
object
Use Use the various properties on EncompassRestClient
such as Loans
, Schema
, Webhook
, Pipeline
, and BatchUpdate
to make Encompass API calls.
Resources
-
Developer Connect - Encompass API's reference location.
-
If you'd like to join our Slack channel please reach out to one of the repo's maintainers.
If you're interested in contributing please look over the Guidelines Doc.