Skip to main content

Authorization

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

OfficeSpace Software

Prerequisites​

To connect Nexla to your OfficeSpace Software instance, you will need an active OfficeSpace account with administrator access and an API token for your OfficeSpace instance. OfficeSpace authenticates API requests using a token-based scheme — each request from Nexla is signed with your API token and routed to your specific instance subdomain.

Obtain Your OfficeSpace Instance Hostname​

Your OfficeSpace instance hostname is the subdomain of your OfficeSpace URL. For example, if your OfficeSpace environment is accessed at mycompany.officespacesoftware.com, your hostname is mycompany.

  • If you are unsure of your instance hostname, contact your OfficeSpace administrator or check the URL you use to log in to OfficeSpace.

Generate an OfficeSpace API Token​

OfficeSpace API tokens are generated from the Admin section of your OfficeSpace instance. Only users with Super Administrator privileges can create and manage API keys.

  1. Log in to your OfficeSpace instance with a Super Administrator account.

  2. In the left-side navigation bar, locate and click the Admin section to expand the admin menu.

  3. Select OfficeSpace API from the admin menu. This opens the API Key management screen.

  4. Click the button to create a new API key. OfficeSpace currently supports Full Access as the API key scope — this grants Nexla the ability to read and write data through the OfficeSpace API.

  5. Copy the generated API token and store it securely. You will need this token when creating the Nexla credential.

API keys are instance-specific and are tied to your OfficeSpace subdomain. Keep your API token secure and do not share it. For additional information about managing API keys in OfficeSpace, refer to the Managing API Keys article in the OfficeSpace Help Center.

Create an OfficeSpace Software Credential​

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

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 to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Token Authentication​

OfficeSpace Software uses token-based authentication. Nexla will include your API token in the Authorization request header (formatted as Authorization: Token token=<your_api_key>) on every API call to your OfficeSpace instance.

  1. Enter your OfficeSpace instance subdomain in the Instance Hostname field. This is the portion of your OfficeSpace URL that precedes .officespacesoftware.com. For example, if your OfficeSpace environment is at mycompany.officespacesoftware.com, enter mycompany.

  2. Enter your OfficeSpace API token in the API Key field. This is the token generated from the Admin > OfficeSpace API section of your OfficeSpace instance. The API key authenticates all Nexla requests to your OfficeSpace environment and should be kept secure.

Important

Your API Key is a sensitive credential. Do not share it or expose it in logs or source control. If you believe your key has been compromised, regenerate it immediately from the Admin > OfficeSpace API screen in your OfficeSpace instance.

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.