Onboarding Guide

Disclaimer: This Developer portal is exclusively for organisations that maintain a service contract with ARTC. Requests for access will be immediately rejected unless a prior established relationship and agreement are in place.

This guide will explain the steps required for access to the ARTC Developer Portal and APIs. These steps need to be followed for all user accounts that require access to the ARTC Developer portal and APIs. Note user accounts must be connected to your organisations Microsoft Entra Identity Platform. Accounts that cannot be invited as guests into another tenancy (e.g. On-prem Active Directory accounts) are not compatible.

The steps needed to be followed are given below:

  1. Developer Portal Access Request

    1. Start by sending an email to the ARTC Service Desk (ServiceDesk@artc.com.au), using details below

      • Email Subject: "Access Request to ARTC APIs and Developer Portal"

      • Email Body Details:

        • Indicate which ARTC business contact has approved API Access and any established data sharing agreement. This will need to be confirmed before we can proceed.

        • Indicate to Service Desk that this is a request first for the service desk team to add users listed below as guest users into the ARTC tenancy, then this should be passed on to the Application Services Team.

        • A description of which API(s) you are requesting access for, and any specific organisational level permissions if you are aware of them.

        • A list of users, for each user please include:

          • name & title/role

          • email address

          • company, department, team

          • Access scope (typically this is 'production' unless you have discussed access to the ARTC 'staging' environment)

    2. Action on ARTC: After you have submitted your support ticket to service desk, you will need to wait until the ARTC service desk processes your request.

  2. Accept Email Invite

    • If your request is approved and you are not already a guest user in the ARTC Azure tenancy, you will receive a Microsoft Entra ID B2B email invite from us. Please accept this invitation to proceed.

  3. Navigate to the Developer Portal & Sign-In

    1. Now you should be able to open your web browser and navigate to the ARTC Developer Portal (https://developer.artc.com.au). If you have access to our test environment you will also need to visit the ARTC Staging Developer Portal (https://developer.stg.artc.com.au) separately.

    2. Upon landing on the Home page, click on the Sign In button, this will take you to the Sign In page. Once on the Sign In page, click on the Sign In button on this page to proceed. Do not immediately enter your credentials, see next step.

    3. Choose the option "Sign in to an organization." If you don't see this option, it's probably due to your browser automatically signing you in to your existing organization. You can try clearing cookies of your browser, use incognito mode of your browser or try a different browser so you can see this option before proceeding to next steps.

    4. In the subsequent 'Find your organization' screen, type in 'artc.com.au'.

    5. You will then be prompted to enter your credentials (managed by your own organisation).

    6. Upon successful verification, you should gain access to the developer portal.

    7. Respond to previous communication with the ARTC Application Services Team and indicate you have completed sign-in successfully for all requested users. Now that you have completed authentication, your accounts can be granted access to the specific APIs you previously requested access to.

    8. Action on ARTC: Upon receival of your confirmation of prior step completion, the Application services team will grant your specific API access, and respond to your email indicating you should now be able to see the APIs in the developer portal.

  4. User API Access

    1. Sign-in to the developer portal again, this time you should have API(s) visible to study, test and implement integration against.

      • Please read our General FAQ + Authentication FAQ pages under the FAQ dropdown menu. These will among other things help you to understand how to authenticate and retrieve bearer tokens for API consumption. Note this dropdown menu is only visible while logged in to the developer portal.

      • Additional relevant FAQ pages should also be available for API specific questions from the FAQ dropdown menu.

      • For any questions not covered by FAQ, please contact us.

  5. Service Account (non-interactive) API Access

    1. Once you have confirmed the APIs meet your requirements, contact the Application Services Team and request they continue with setting up your organisation with service account credentials with the same permissions (and an additional set for your test environment if it is required).

    2. Action on ARTC: Upon receival of your service account request, the application services team will get this actioned by appropriate teams then get back to you with service account details.