iplicit API

Get started

If you need assistance to kickstart your usage of our API, please don't hesitate to contact us at apisupport@iplicit.com. We're here to help with any inquiries and can also arrange a consultation, which may involve chargeable support, to meet your specific needs.

Guide

Reference

The API base URL is: https://api.iplicit.com

The API version is determined by the version of the target iplicit environment. API version is included in the response body when creating an API session.

Target environment is specified using the Domain header.

Versions

Documentation for the latest version can always be found in the API Reference.

Currently active versions are listed in the table below with links to version specific documentation.

Version API Reference OpenAPI Specification
v1.13 API Reference iplicit API 1.13
v1.12 API Reference iplicit API 1.12

Change log

View the API changelog to keep track of changes and upgrades to the iplicit API.

Authentication

Credentials

As part of your private API registration you should have received a set of credentials:

  • domain
  • user account
  • API key

The API Key should be treated as a secret and stored in a secure manner.

API Keys have an expiration date, multiple API keys can be associated to a user account to allow for periodic rotation of credentials.

Session Tokens

All iplicit API requests must be authenticated using a session token bearer token:

Authorization: Bearer <session token>

The session token is obtained by creating a session for a user account using the API Key credentials:

POST https://api.iplicit.com/api/session/create/api

Parameters Type Description
Domain Header The environment domain (e.g.: sandbox.demo)
username,
userApiKey		 Body The user account credentials to create a session for.
The credentials are encoded as JSON:
Content-type: application/json 
{
  "username": "{{user}}",
  "userApiKey": "{{API key}}"
}

Example

POST https://api.iplicit.com/api/session/create/api
Domain: sandbox.demo
Content-type: application/json

{
    "username": "api_user_10293",
    "userApiKey": "8Ga3a9JaXebGbAgdbJUAhwXG8a12mfsj3Gfd"
}
Response:
200 OK
{
  "tokenDue":"2022-02-09T11:12:39.64Z",
  "sessionToken":"aj4DdxCJ30/1tz8UpCGGyQ02mCPPqoipAQcTvASNQ+VnfKbVTZUKz8",
  "domain":"sandbox.demo",
  "apiVer":"1.7.1"
}

The session token can then be used as a bearer token to authenticate subsequent requests:

GET https://api.iplicit.com/api/document/SIN100
Domain: sandbox.demo
Authorization: Bearer aj4DdxCJ30/1tz8UpCGGyQ02mCPPqoipAQcTvASNQ+VnfKbVTZUKz8

The session token should be reused for all future requests until it's expiry date tokenDue.

Note

  1. Multiple active session tokens can be created using the same API key. Session tokens are treated on an individual basis and will expire after 30mins, regardless of the other tokens expiry time.

  2. There is a rate limit of 1500 requests per 5 minute window. Any requests above this threshold will be blocked for the remainder of the 5 minute window.

Request Headers

All iplicit API requests require certain HTTP headers:

Header Expected Value Required for
Domain The environment domain e.g. sandbox.demo All requests
Authorization Bearer <session token> All requests except Create Session
Content-Type application/json All requests with bodies

Support

For any support questions, please send us an email at apisupport@iplicit.com.


Updated February 2024