LogoLogo
  • Introduction
  • OVERVIEW
    • About ParqEx
      • -- Marketplace
      • -- Access+
      • -- GuestParq & GuestAccess
      • -- Enforcer
    • API Requirements
    • Roles and Permissions
  • GETTING STARTED
    • Requesting an Account
    • Using RESTful Tools
    • Webhooks
  • Embedding ParqEx in Native Mobile Apps
    • Overview
    • FAQ
    • Technical Documentation
      • iOS Implementation Guide
      • Android Implementation Guide
  • THE BASICS
    • Entities
    • Best Practices
    • Testing Accounts
  • OAUTH
    • Overview
    • How to Authorize Access
      • Step 1: Generate Authorization URL
      • Step 2: Handle Authorization Response
      • Step 3: Request an Access Token
      • Step 4: Call API Endpoints
      • Step 5: Refresh the Tokens
  • API ENDPOINTS
    • Overview
    • Get User Info
    • Get User Settings
    • Get User Devices
    • Toggle Access Point
    • Invite User (internal)
    • Get Access History
Powered by GitBook
On this page

Was this helpful?

  1. OAUTH
  2. How to Authorize Access

Step 1: Generate Authorization URL

Sending the user to this link will redirect the user to the ParqEx website from which they may login (if they do not already have an active session) and choose whether to allow your application to connect to their ParqEx account. After the user elects to ALLOW or DENY, the user is redirect to the supplied ENCODED_REDIRECT_URL.

Which should match the format (line breaks added for clarity):

https://api.parqex.com/oauth/v2/endpoints/authorization/?
    response_type=code&
    client_id=<CLIENT_ID>&
    redirect_uri=<ENCODED_REDIRECT_URL>&
    scope=<SCOPE>&
    state=<STATE>

For example, with some real data (line breaks added for clarity):

https://api.parqex.com/oauth/v2/endpoints/authorization/?
    response_type=code&
    client_id=555555555555555555.api.parqex.com&
    redirect_uri=https%3A%2F%2Fexample%2Eorg%2F&
    scope=opendoor,closedoor&
    state==dzRBV1RxdWg5S0JWUTBhMGpEUy9NT3lGS2xjbkRsMHBDeEJDTXdPS1JpRzhlS3FFRmorOHo2SUoxZmlYb0o4dE8wRGM3Nnhwd0xNbWRIUWUvSmptM2c9PS0tSk4yM1Y2ckR1WmZCUGxjc3JBWDBhdz09--e6f508aa05569a93aaa02414c20ab808e8fbda49

Available Scopes

The <SCOPE> param should be supplied a comma-separated list of the following abilities depending on the use-case of your application. These values are not case-sensitive.

OPENDOOR - This scope enables the integration to open the door.

CLOSEDOOR - This scope enables the integration to close the door.

PreviousHow to Authorize AccessNextStep 2: Handle Authorization Response

Last updated 4 years ago

Was this helpful?