Lowell APIs

Streamline your process and take you customer experience to the next level.

Getting started

Lowell is developing a set of modern APIs to enable our clients to innovate and improve their processes. For the latest news and updates please sign-up.

Currently accessing the APIs is limited and you need to contact us to gain the access.

APIs


Ledger API	Collection API	User API
Enables ledger access with operations like changing due dates and account numbers	Send in new claims	Manage the portal (Lowell Access) users and their permissions
Status: In production	Status: In production	Status: In development
Documentation	Documentation

Technical

Environments

Lowell has test and production environments. Due the nature of the services we often use client data to setup the test environment instead of using a ready made sandbox. You can read more about the environments from the API specific documentation.

Security

Lowell APIs use OAuth based authentication and authorization. Accessing the APIs mostly follow the basic OAuth 2.0 Client Credentials flow which requires the API client to retrieve the Access Token (JWT) from Lowell Identity Provider (IDP) by using clientId-clientSecret -pair. The retrieved token is then added to the authorization header of the API call.

Different APIs might have different security needs and exceptions to the authentication flow are explained in the API specific documention.

Retrieving and using the access token

The Access Token can be retrieved with a GET-request using the clientId and clientSecret. Please see the Curl example below and other examples from our Github:

				curl -k --data "grant_type=client_credentials&client_id=<clientId>&client_secret=<clientSecret>" https://idp.lowell.io/auth/realms/<environment>/protocol/openid-connect/token
			

Please replace the <environment> with test-clients for test environment and clients for production environment. Lowell will provide clientId and clientSecret for both environments.

When calling the actual API you need to set the Authorization header value to Bearer <Access Token> where <Access Token> is the actual token you got from the Lowell IDP.

Examples

We provide example code snippets on Github. For bug reports and proposals you can contact us or create a pull request.