Restful Services
Overview
Encompass provides a set of restful web services using JSON. Our services use OpenAPI Specification 3.0 (formerly "Swagger"). Our documentation is hosted on SwaggerHub. This allows interactive API documentation. You can even try the services directly from the site, pull SDK's and server stubs to make development faster.
Requirements
All services require a user name and password that must be obtained from Encompass, this is separate from your regular Encompass account. You must also have a net terms account, as we do not allow credit card accounts to access our API. Please contact your Encompass account manager for more information.
Links
| Description | URL |
|---|---|
| Interactive Documentation | https://app.swaggerhub.com/apis-docs/Encompass.com/RestfulServices/1 |
| SDK, Server Stubs, Etc... | https://app.swaggerhub.com/apis/Encompass.com/RestfulServices/1 |
| JSON API | https://api.swaggerhub.com/apis/Encompass.com/RestfulServices/1 |
| YAML API | https://api.swaggerhub.com/apis/Encompass.com/RestfulServices/1/swagger.yaml |