Getting Started
Welcome to the CIC Plus developer portal!
We offer a set of Application Programming Interfaces (APIs) that can give you the ability to integrate your business with the product offerings from CIC Plus. This guide gives you an overview of the process, from creating an account and test environment to writing code.
Prerequisites
Before you can get started, you must have a sandbox account.
Once your account has been approved and created, you will receive an email with your account information, which includes your sign in credentials.
Line-of-Business (Products)
APIs are grouped by line-of-business (products). You can have access to multiple business lines but must specifically request access to each and be approved.
Most APIs will only work with other APIs in the same line-of-business. There are APIs that span all lines of business, like the Authorization endpoint.
Some APIs are dependent on others and follow a specific flow. These dependencies will be documented for each line-of-business in its own section.
Product Subscription
After you login you may explore our available online resources and subscribe to one of our API Products. Details on the subscription process can be found here.
Authorization
Most of the API endpoints require Bearer authentication, also known as Token authentication. To get a token, you will need to submit a POST request using Basic authentication to the Authorization endpoint:
https://developer.q1.paperlessemployee.com/api/Authorize/Token?userName=your-username&userPassword=your-password&companyUrlSuffix=yourcompanyname
For subsequent requests, the token will then be sent in the Authorization header in the format:
Authorization: Bearer <token>
The API token will expire in 60 minutes.
More details on our authorization process can be found here. You may download the sample code from GitHub.
Accessing the API
In general, each API request will consist of the following:
An HTTP request, for example ‘HTTP Get’ or ‘HTTP Post’. These are submitted to a particular API endpoint. Note that endpoints are not case-sensitive.
An Authorization header, for example ‘authorization: basic’ or ‘authorization: bearer’.
Optionally it may include one or more parameters on the URL, for example: https://{apiurl}.com/endpoint?parameter1=value1¶meter2=value2
Optionally there may be a payload. If so, it's important to use a supported content-type such as: application/json or application/xml.
Help and Support
To get additional help and support, please visit our FAQ page. If you cannot find your answers there then you may contact supportapi at CIC Plus dot com.