Skip to main content

Authorization

Follow this guide to create a new StarRez credential that will allow Nexla to authenticate to and exchange data with your StarRez account.
starrez_api_auth.png

StarRez

Prerequisites​

Before creating a StarRez credential, you'll need to obtain your StarRez portal username and password. StarRez uses Basic Authentication for API access, requiring your portal credentials to authenticate REST API requests.

To obtain StarRez API credentials:

  1. Log in to your StarRez portal. You'll need access to your StarRez instance with appropriate permissions for API access.

  2. Contact your StarRez administrator or StarRez support to ensure that REST API access is enabled for your account. REST API access may need to be configured at the portal level.

  3. Verify that your user account has the necessary permissions to access the REST API endpoints you need. Different endpoints may require different permission levels.

  4. Note your Domain URL (instance URL). This is the base URL for your StarRez instance. For example, if your API documentation is available at https://nexla.starrezhousing.com/StarRezREST/services, then your Domain URL is https://nexla.starrezhousing.com (or just nexla.starrezhousing.com).

  5. Ensure you have your Username and Password for your StarRez portal account. These are the same credentials you use to log in to the StarRez web portal.

StarRez uses Basic Authentication with username and password for REST API access. Your portal credentials are used to authenticate API requests. Make sure your account has the necessary permissions to access the REST API endpoints you need. If you're unsure about your API access or permissions, contact your StarRez administrator or StarRez support.

For detailed information about StarRez REST API authentication and access, refer to the StarRez Documentation.

Create a StarRez Credential​

  • To create a new StarRez credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – StarRez

StarRezCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the Domain URL field, enter the URL of your StarRez instance. This should be the domain name without the protocol prefix. For example, if your API documentation is available at https://nexla.starrezhousing.com/StarRezREST/services, then your Domain URL is nexla.starrezhousing.com. The default value is nexla.starrezhousing.com.

  2. In the Username field, enter your StarRez portal username. This is the username you use to log in to your StarRez portal.

  3. In the Password field, enter your StarRez portal password. This is the password you use to log in to your StarRez portal.

    The password is sensitive information and should be kept secure. Your StarRez portal credentials are used for Basic Authentication to access the REST API. Make sure your account has the necessary permissions to access the REST API endpoints you need.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.