Base URLs

Overview

PageUp APIs are generally reached through a common URL structure. The base URL for your integration depends on the environment, the data centre where your organisation is hosted, your tenant Id and the API you are calling. This page describes each part once; the individual API pages show only the path that is specific to that API.

Contents

1. URL Structure
2. Environments
3. Datacentres
4. Tenant Id
5. Examples
6. APIs on a separate URL

URL Structure

Root URL:
https://<environment>.<dataCentreId>.pageuppeople.com/v3/<tenantId>/<api-path>/...

The authentication credentials used in your API calls must match the environment, data centre and tenant Id in the URL. To request an access token, see Authentication.

Environments

Each PageUp customer has both a UAT and a LIVE environment. You will be provisioned UAT credentials until you are ready to go live.

Datacentres

PageUp hosts customers all around the globe. Each data centre is assigned a unique identifier, which forms part of the host name.

The API specifications on this portal show the host as api.dcX.pageuppeople.com. Replace dcX with the data centre where your organisation is hosted. Please contact your PageUp representative to find out your data centre if it is not known.

Tenant Id

The tenant Id identifies your organisation (e.g. 218). It is shown as {tenantId} or <tenantId> in the API specifications and documentation. Please contact your PageUp representative to find out your tenant Id if it is not known.

Examples

Connect to the Core HR Agreement API for the 218 LIVE environment on dc2:

https://api.dc2.pageuppeople.com/v3/218/hrcore/agreement

Connect to the Background Checking API for the 218 UAT environment on dc3:

https://apiuat.dc3.pageuppeople.com/v3/218/backgroundchecking/12345

APIs on a separate URL

Some APIs are not reached through the common URL structure above. These are documented on their own API page. For example, the SCORM content upload used with Learning Activities is available at: