Skip to main content

Search

Welcome to the Eploy Knowledge Base

Eploy RESTful API: Requirements

Integrations
  • Updated

Requirements

Before you can begin using the API, you will need:

  • An Eploy system with the API enabled, and with any configuration* necessary for your integration in place.
    • Note: the ‘Base URL’ to access the API will be the URL of your Eploy system, followed by /api/ (e.g. https://ourcompanyname.eploy.net/api/). All the example API URLs in the API Integration Examples section start with /api/ which needs to be replaced with the full Base URL for your system.

* configuration requirements may consist of custom fields, drop down entries, export packages and workflow element such as Application Stages, Action Type, Action Outcomes etc.

  • An API User to allocate to your API Key
    • Note: an API User can be any Standard user in your system, however, we recommend having a user set up specifically for the API (i.e. not a user who is logging in to Eploy). The API User also must have:
      • Only one ‘Role’ associated (users with more than one role cannot be allocated to an API key).
      • At least one IP range  configured in the ‘Restricted IP Access’ section. For maximum security, we recommend limiting the IP ranges only to those that you are going to be calling the API from. It is, however, possible to allow all IPV4 and/or all IPV6 ranges by including the following ranges, if necessary:
        • (for all IPV4 ranges) 0.0.0.0/0
        • (for all IPV6 ranges) ::/0

Please refer to the article "Eploy RESTful API: Setting Up An API User" for more information on setting up an API User

  • An API Key with permissions set, providing you with
    • A Client ID
    • A Client Secret

Please refer to the article "Eploy RESTful API: Setting Up An API Key" for more information on setting up an API Key

Related to