Overview and context

Get an understanding of Application Programming Interface (API) connections and how APIs work with Sage.

What is an API?

An Application Programming Interface (API) allows two systems to communicate and exchange data seamlessly. APIs define how systems make data requests, what responses you can expect, and how systems interact securely. A fancy name, but a simple idea. APIs:

  • Act as a bridge between two applications that need to exchange data

  • Provide developers with a set of tools and rules for how to interact with applications and functionality

  • Are everywhere - when booking flights, making payments, checking the weather

  • Let developers build interesting things using existing systems in a secure and scalable way

What is a REST API?

REST API stands for Representation State Transfer. This means you send a request, and you get a response. For example, when you order a takeaway but you don’t need to call the restaurant. REST APIs are also:

  • A popular style of API built for the web

  • Define - simple rules that let two applications communicate over the internet

  • Simple - they offer developers the simplicity to connect apps, websites, and databases

  • Consistent - they follow predictable patterns, making them reliable and less error prone

  • Secure - manages access and permissions and protect sensitive data

  • Flexible - work across different platforms and speak the same language

How do third-party systems interact with Sage People using REST API?

Third-party systems make API calls to Sage People to retrieve standard information about team members, including:

  • Employee-level data - indicative information about the team member

  • Payroll-related data - such as salary, bonuses, benefits, absences, and timesheets

Why is API integration important?

APIs allow real-time or scheduled data retrieval. This reduces manual data entry errors, improves efficiency, and ensures accurate payroll processing. It does this by pulling the latest employee records from Sage People into Third-party systems.

Technical Components

Salesforce REST API

Typical Salesforce REST API integration principles include:

  • External Client App - you configure this in Salesforce to allow third-party applications to authenticate and exchange data securely with Sage People

  • API User - a dedicated Salesforce user with API permissions you assign via permission sets

  • Permission Sets - custom or standard Salesforce permissions ensuring the API user can access the necessary employee and payroll-related data fields from Sage People

  • Object and Field-Level Security - controls access to relevant data for API GET requests. For example, Salary, Bonus, Benefits, and timesheets

These components enable consistent data exchange, ensuring automated data retrieval and reducing manual input errors.