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. GETTING STARTED

Requesting an Account

Before you can attempt to make an authenticated request, you must first register your application with the ParqEx service by emailing ParqEx Support at support@parqex.com. ParqEx will then generate an account and return the credentials (a client_id and client_secret) to the developer's contact email.

You must supply ParqEx with the following:

  • Developer Contact Information

    • Name

    • Email address

  • Company/Product Name (eg. Google)

  • Company/Product Website URL (eg. https://google.com)

  • Application Name (can be same as company/product name)

  • Description of Application (can be same as company/product desc.)

  • Website URL of Application (if different than Website URL)

  • Your Redirect/Callback URL for OAuth (e.g. https://mysaasproduct.com/oauth/v1/authorize)

A Note about Mulitple Environments - Most applications have multiple environments (eg. development, certification, production, etc.). If your application has more than one environment, you must supply the additional information for each environment as separate credentials will need to be created for each. Supply the following for each different environment:

  • URL for application (eg. qa.example.com)

  • Redirect/callback URL for OAuth

Example Request Email

Please use the following format to compose the email and send it to support@parqex.com:

Dear Support,

I am requesting OAuth credentials for the below application.

Name of Developer Contact: John Doe Email Address of Developer Contact: john@myhomeapp.com Name of Company/Product: MyHome Inc. Website Address of Company/Product: https://myhomeapp.com Name of Application: MyHome Description of Application: MyHome allows users to monitor who is home and send notifications when someone leaves or returns.

MyHome has two environments, DEV and PROD.

For DEV:

Website Address of the Application: https://dev.myhomeapp.com Redirect or Callback OAuth URL: https://dev.myhomeapp.com/oauth/v1/authorize

For PROD:

Website Address of the Application: https://myhomeapp.com Redirect or Callback OAuth URL: https://myhomeapp.com/oauth/v1/authorize

Note: The Redirect URL (or Callback URL) is the endpoint Beam will redirect the user after they authorize (or deny) your application.

Important: The OAuth redirect/callback URL must start with https://. Insecure URLs will not be accepted

PreviousRoles and PermissionsNextUsing RESTful Tools

Last updated 4 years ago

Was this helpful?