Getting Started

Integrating your application(s) with Atlas is smooth and simple with our open API endpoints

This guide will help you get started with using Atlas Connect APIs

Easy Access and Modification

The Atlas Connect APIs is a RESTful protocol that allows you to make HTTPS requests to access or modify resources, typically managed by your team. You can use the APIs to initiate the employee onboarding process, modify employee details, and much more coming soon!

Requirements to Get Started

An HTTP Client:

  • For an AtlasHXM user:

    • An account with AtlasHXM

    • An API key (Refer to the Authentication section below for instructions on obtaining an API key)

Authentication

Every API request from a third-party application to the AtlasHXM website will be authenticated and authorized as if a client is using the platform. The permissions of the client associated with the API request will determine which fields and employees each API request can view and/or edit.

Each client has a unique API key that identifies them to the API. The API secret key is a 160-bit number expressed in hexadecimal form, resulting in an astronomically large number of unique keys, making it virtually impossible to guess an API key.

At the HTTP level, the API key is transmitted via HTTP Bearer Token. Use the secret key as the value of the Authorization header. More details are contained in the “Authentication” section.