Authorization and Credentials

POS Portal requires secure authorization for all API interactions. Currently, POS Portal supports OAuth 2.0 as the method for securing API access. OAuth 2.0 is an industry-standard protocol for authorization that ensures secure and reliable access to your account and resources.

To begin using the POS Portal API, you will need to obtain the necessary credentials. These credentials are used to authenticate your API requests and grant access to the various endpoints.

Requesting API Credentials

To request credentials for access to our sandbox or production environment, please contact your Account Manager or business contact at POS Portal. Here’s what to expect:

• Sandbox Credentials: Can be issued within 5 business days after the POS Portal sandbox environment has been refreshed, assuming the client account has already been created in Production. Your POS Portal Account Manager will need to create the new client account in Production.
• Production Credentials: Issued within 10 business days.

Note: We recommend completing development in the Sandbox before requesting Production credentials.

Our preferred method of distributing credentials is through LastPass. You can create a free account here to receive them. If this method doesn’t work for you we can arrange an alternative.

LastPass Instructions:

1. Email Notification: The recipient receives an email from LastPass indicating that Kevin Cowan has shared a secure note. The email includes a link to access the shared note.
2. Account Requirement: If the recipient already has a LastPass account, they can log in to their account to access the note. If they don’t have a LastPass account, they will need to create one (free or paid) to view the note. The email provides instructions for this.
3. Viewing the Note: Once logged in, the recipient will see the note in the "Shared with Me" folder within their LastPass vault.
4. Action Required: If the recipient needs to set up a LastPass account, they must follow the prompts to sign up before accessing the note. If they already have an account, they simply log in and navigate to their vault to find the shared note.

Once you have your credentials, you can use them to authenticate API requests via OAuth 2.0, ensuring secure and authorized interactions with the POS Portal API.