API Documentation

Introduction

This article specifies the API for interfacing with Ivinex.  If you have any problems or requests, please contact us for support.

Getting Started

Before you can make any API calls, you must first define what user will be used for the calls. The User must be an active user and have API permissions. API permissions for the User can be assigned through the group manager (for all users in a specific group), or the user manager (for a specific user).

Warning: Most problems you may encounter when using the API will be related to permissions. The user account that you are using for API calls is LIMITED by the PERMISSIONS granted to that user.

General Information

• Default Record Fields: There are a few fields that are automatically generated for every record in Ivinex. As long as there is at least one record in a module, these fields are always available.
  • Created By: created_by (The username of the person who created the record.)
  • Created Date: created_date (The date the record was created.)
  • Modified By: modified_by (The username of the person who last modified the record.)
  • Modified Date: modified_date (The date the record was last modified.)
  • Record ID: collection_id (The ID of the record.)

API Calls

All calls use HTTPS or HTTP.   The Base URL is: https://.ivinex.com/API/

Where  is the name of your unique Ivinex site.

Note: This is the same URL that you would type in to access your Ivinex system iwth the "/API" appended to the end.

For the purpose of this guide, we will assume a siteID of “company” where “company” would be replaced with your unique Ivinex site.

We will also be assuming a UserName of “user” and a Password of “password” where “user” and “password” would be replaced by your API enabled User.

The following Calls are available:

• GetTabs
• GetFields
• GetRecords
• AddRecord
• UpdateRecord
• GetRelatedItems
• GetAllRelatedItems
• LinkRecords

For all API Calls, the following parameters are required:

UserName  –  UserName to login to Ivinex

Password  –  Password to login to Ivinex