OAuth 2.0

What is OAuth 2.0?

“Open Authorization” better known as OAuth 2.0 is an Authorization standard allowing websites and applications secure access to resources on behalf of a user.

It replaces OAuth 1.0 as an Industry go to standard thanks to its high level of security and interoperability across multiple domains. OAuth 2.0 relies on Access Tokens to provide resource access to users of a platform. There is no set standard for what defines an Access Token although JSON Web Tokens are the most common. These tokens include data that represents the authorization for a user to access resources.

Understanding Authorization at Proximie

Proximie support two main methods of Authorization

Authorization Code / PKCE
Client Credentials

Application Type	Authorization Type	Use Case
Web App * Mobile App * Desktop App *	Authorization Code / PKCE	For users wanting to integrate and authorize via a front end client.
Server Integrations * Physical Devices *	Client Credentials	Single devices that require access that don't need cross application authorization.

Which Authorization flow should I use?

I want to...	Flow
Develop an application that users will log into	Authorization Code / PKCE
Create an integration for a device with no User facing UI.	Client Credentials

These flows are covered with more detail in the following sections.

What is the URL I should use?

In order to integrate correctly Proximie provide two environments for development.

Integration Status	URL	Description
Development	https://my.proximiestaging.com	When integrating initially use the Development environment to ensure the integration is successful. This prevents any test data from entering and being displayed within your Organisation.
Production	https://my.proximie.net	Once you have completed development and are happy with the status of the integration you can now switch to the Production environment. This will be fully supported by Proximie and is guaranteed to provide the highest level of service ensuring that your product remains fully functional, even under the heaviest of loads.