---
title: Creating an API Access Token
---

[Skip to content](https://support.apxium.com/knowledge/practice-engine-creating-an-api-access-token#main-content)

English

Show submenu for translations

![apxium-logo.png\]](https://support.apxium.com/hs-fs/hubfs/Logos/apxium-logo.png?width=144&height=50&name=apxium-logo.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations

 Hello. How can we help you?

- There are no suggestions because the search field is empty.

1. [Apxium Help Center](https://support.apxium.com/knowledge?hsLang=en)
2. [Apxium Collect](https://support.apxium.com/knowledge/apxium-collect?hsLang=en)
3. [Integrations](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#integrations)

# Creating an API Access Token

## For Practice Engine Users

We only need read-only access to PE for the sandbox. The sandbox does not write back or actually send any emails. It is a safe environment to trial out Apxium.

 

Go to your Practice Engine site and go to Admin → API Authentication Administrator, or go directly to [https://yourdomain.pehosted.com/PE](https://yourdomain.pehosted.com/PE/Admin/APIAuth)

![Administer API Access](https://support.apxium.com/hs-fs/hubfs/Downloads/Screenshot%202023-11-24%20125732_PE.png?width=670&height=239&name=Screenshot%202023-11-24%20125732_PE.png)

 

Practice Engine allows other applications to call into its web API's just like any other user. This is done with an AppId and AppKey.

On this page, you can administer and create AppId's and AppKey's which can be used when calling the /API functions. AppId's simply map to a standard user so that all normal security measures still apply.

- Choose a user to map the API Access to.
- Click on “Create New App ID”, Enter the User ID of the chosen user and click Save.
- Record the App ID, App Key, and the hostname of your Practice Engine instance, as you will need to enter these details in the Apxium Sandbox server that we will provide to you.

---

### Creating a user with permission (if required)

The Apxium integration requires the following permissions to work:

- API\_Admin
- API\_Banking
- API\_Billing
- API\_Client
- API\_Export
- ClientDRS
- ClientSearch
- LodgeHeader

The user that the API key is mapped to must have at least these permissions. If needed, please go to [https://yourdomain.pehosted.com/PE/Admin/Security](https://yourdomain.pehosted.com/PE/Admin/Security) (Admin → Task Pad → Security Administration).

Go to Permissions to view which groups have these permissions already or create a new group and assign the permissions if desired.

If necessary, create a new user (Staff Member) to use for the integration or choose an existing user.

Go to the Members tab to assign the user to a group with these permissions if required.

Once this is complete, return to your Apxium dashboard, navigate to the \*\*Admin\*\* page, and update your API credentials.

 

- [Article Navigation Guide](https://support.apxium.com/knowledge/article-navigation-guide?hsLang=en#main-content)

    - [Article Navigation Guide](https://support.apxium.com/knowledge/article-navigation-guide?hsLang=en#article-navigation-guide)
- [Apxium Collect](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#main-content)

    - [General Features](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#general-features)
    - [Communications](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#communications)
    - [Client Experience](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#client-experience)
    - [Payments, Settlements & Reconciliations](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#payments-settlements-reconciliations)
    - [Engagement / Proposals](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#engagement-proposals)
    - [APX Auto (Direct Debiting Invoices)](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#apx-auto-direct-debiting-invoices)
    - [Instalment Agreements (Non-SOR On Balance Sheet Instalments)](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#instalment-agreements-non-sor-on-balance-sheet-instalments)
    - [Professional Fee Funding (SOR) - Funded Instalments](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#professional-fee-funding-sor-funded-instalments)
    - [Reports](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#reports)
    - [Integrations](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#integrations)
    - [Onboarding Articles & Other Helpful Guides](https://support.apxium.com/knowledge/apxium-collect?hsLang=en#onboarding-articles-other-helpful-guides)
- [Apxium Audit Safe](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#main-content)

    - [General Features](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#general-features)
    - [Creating Offers/Subscriptions](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#creating-offers-subscriptions)
    - [Offer Emails and Documentation](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#offer-emails-and-documentation)
    - [Accepting / Declining Audit Safe Subscription](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#accepting-declining-audit-safe-subscription)
    - [Active Audit Safe Subscriptions](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#active-audit-safe-subscriptions)
    - [Audit Safe Renewal / Rollover](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#audit-safe-renewal-rollover)
    - [Pricing](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#pricing)
    - [Others](https://support.apxium.com/knowledge/apxium-audit-safe?hsLang=en#others)
- [Apxium Pay My Bill](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#main-content)

    - [Pay My Bill](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#pay-my-bill)
    - [Payments and Settlements](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#payments-and-settlements)
    - [Communications](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#communications)
    - [APX Auto (Direct Debiting Invoices)](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#apx-auto-direct-debiting-invoices)
    - [Payrix](https://support.apxium.com/knowledge/apxium-pay-my-bill?hsLang=en#payrix)
- [Client POS - Non Integrated \[North America\]](https://support.apxium.com/knowledge/client-pos-non-integrated-north-america?hsLang=en#main-content)

    - [Client POS - General Features](https://support.apxium.com/knowledge/client-pos-non-integrated-north-america?hsLang=en#client-pos-general-features)
- [APX Capital - Tax Pay for Introducers](https://support.apxium.com/knowledge/apx-capital-tax-pay-for-introducers?hsLang=en)
- [APX Capital - Tax Pay For Borrowers](https://support.apxium.com/knowledge/apx-capital-tax-pay-for-borrowers?hsLang=en)

[![Apxium Advanced Software Solutions for Accountant](https://support.apxium.com/hs-fs/hubfs/Logos/apxium-logo.png?width=144&height=50&name=apxium-logo.png "Apxium Advanced Software Solutions for Accountant")](http://www.apxium.com?hsLang=en)

<https://www.youtube.com/channel/UCWTG_WTvbFQ-2YD3GBMl_2g> <https://au.linkedin.com/company/apxium> <https://www.facebook.com/Apxium/>

Copyright © 2025, Apxium HQ