PSIber API Guide Introduction Get Started Authentication Company Level Requests Payroll Level Requests Employee Level Requests Security & Permissions External Connections

Introduction

Welcome to the PSIber API

Our API’s enable you to access your company’s Human Capital Management and Payroll data, to optimise your business environment. It further enables you to integrate PSIber with your third-party systems.

OpenAPI Specification or Swagger Specification allows the documentation of APIs, including:

  • Available endpoints.

  • Operation parameters Input and Output for each operation.

  • Authentication methods.

  • Contact information, license, terms of use, version and other information.

Available Actions

  • GET: Read/Fetch Information

  • POST: Create Information

  • PUT: Update Information

Media Types

The PSIber API Module only makes provision for content type JSON:

application/json

GET Requests

  • Responses are returned as JSON.

  • Successful requests return a HTTP 200 Status Code.

POST and PUT Requests

  • Requests only accept content-type JSON.

  • Successful requests return HTTP 200 or HTTP 201 Status Codes.

Responses

  • 200 OK/Continue - authorized

  • 201 Created

  • 401 Validation error/Unauthorized - Invalid or no token

  • 403 Forbidden

  • 404 Not Found

Available URL's

PRE

This is our pre environment and best used for TESTING/DEVELOPMENT purposes.

https://pre.api.psiberworks.com/restapi
LIVE

The below URL is for accessing the PRODUCTION environment.

https://api.psiberworks.com/restapi/

Limits

Rates are limited to 500 requests per minute.

Attachments/Files being uploaded are limited to 50Mb per file.

Documentation

Resources are documented with Swagger UI, and can be explored from the homepage: