Articles in this section

See more

Supplier Contractor Register API

  • Updated

This article explains how to use the Assure Customer API (a secure RESTful API that enables automated integration with Assure) to create, update, and delete Supplier Contractor Register records (the register used to manage supplier and contractor details, including contact information, insurance, service scope, and audit data) in Assure. It covers what the API can and cannot do, the minimum required fields, the full list of optional fields, what is currently out of scope, and the steps to set up the API.

The Customer API functionality must be enabled by Evotix before use and requires a level of technical expertise, typically handled by a company's IT function. This article applies to the Supplier Contractor Register module within the Contractor Management area of Assure.

 

Prerequisites

Before using the Customer API to manage Supplier Contractor Register records, confirm the following are in place:
  • API access is enabled - The Customer API functionality must be activated by the Evotix team. Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request access.
  • API authentication keys are generated - API keys must be created and managed in Assure before making any API requests. Refer to the API Key Management article for instructions.
  • Technical resource is available - The Customer API requires a level of technical expertise to configure and operate. Implementation is typically handled by a company's IT function.

 

What is the Assure Customer API?

The Assure Customer API can be used to automate the processes of managing Supplier Contractor Register records in Assure. The API is accessed via the internet as a secure RESTful API, which is widely supported by integration platforms, ETL tools, and all programming and scripting languages, making it straightforward to integrate with external systems.

 

What Can the Customer API Do?

With the Customer API, an administrator can perform the following operations on Supplier Contractor Register records:
  • Create new Supplier Contractor Register records
  • Update existing Supplier Contractor Register records
  • Delete Supplier Contractor Register records
Each of these operations requires the caller to submit a request to the Customer API. Full details of the API methods, request structure, field types, and data validation rules are documented in two places:
  • Supplier Contractor Register API User Guide (Guide 8) - the step-by-step implementation guide covering how to construct requests for Supplier Contractor Register records. Download the guide here: Customer API User Guide - Supplier Contractor Register API
  • Assure Customer API OpenAPI Schema - the master definition of all API methods, JSON object structures, required fields, field types, maximum data lengths, and string patterns. The schema is hosted on GitHub and is updated automatically as new functionality is released: https://github.com/Evotix/public-assure-customerapi

 

What Details Must Be Provided?

The minimum required fields are:

  • Org Unit
  • Reference
  • Supplier Name
  • Plus any other fields which you have set as a mandatory requirement in the Supplier Contractor Register caption maintenance.

Other fields that can be set and will be defaulted if not supplied:

  • Is Confidential
  • Supplier Code
  • Address 1
  • Address 2
  • Address 3
  • Town
  • County
  • Postcode
  • Telephone Number
  • Fax Number
  • Email
  • Locality
  • Areas of availability

Contact Information

  • Contact Name
  • Contact Telephone number
  • Contact Email
  • Health and Safety Officer
  • Health and Safety Officer Telephone
  • Health and Safety Officer Email
  • Line Manager
  • Line Manager Telephone
  • Line Manager Email
  • Sponsor
  • Sponsor Telephone
  • Sponsor Email

Service Information

  • Product Supplied
  • Details of last work
  • Last order work date
  • Work to be undertaken

Insurance Details

  • Insurance Type
  • Is liable
  • Expiry
  • Indemnity Limit

Scope of Services

  • Category
  • Sub Category

Personnel

  • Personnel Reference

Audit

  • Audit Reference

Conclusion

  • Additional Information
  • Comments
  • Supplier Status
  • Star Rating
  • Additional Date 1
  • Additional Date 2
  • Approval Date
  • Induction Type

 

Out of Scope

The following elements are not currently supported by the Supplier Contractor Register API:
  • The Supplier Contractor Register reference field cannot be changed via the API. The API can only create new records with a unique reference, or update records where an existing record for the provided reference already exists.
  • The Supplier Contractor Register reference field cannot be automatically assigned by the system. When creating or updating records, the reference must be explicitly provided in every request.
  • Supporting items cannot be added via the API. This includes Actions, attachments, notes, reviews, and links to policies and guidance.
  • Default reviewers and approvers configured in Assure are automatically applied on record creation via the API.
  • Default values set within Caption Maintenance are not taken into consideration by the API. Any default values configured at the module level do not apply to records created or updated through API requests.

 

Setting Up the API
 
Follow these steps in order to configure the Supplier Contractor Register API.

Step 1: Request Access

Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request that the Customer API functionality is enabled on your Assure account.

Step 2: Create and Manage API Authentication Keys

Create and manage your API authentication keys in Assure at any time. Full instructions are available in the API Key Management article:

Step 3: Configure the Customer API (Getting Started)

Set up the Customer API by following the Getting Started user guide:

Step 4: Configure the Supplier Contractor Register API

Set up the Supplier Contractor Register API by following the dedicated user guide:

 

AI Metadata

  • Product Area: Customer API Management, Contractor Management (Supplier Contractor Register)
  • User Role: IT Administrator / Integration Engineer (technical implementation); Assure System Administrator (access request)
  • Tags: Customer API, Supplier Contractor Register, Contractor Register, create supplier record, update contractor record, delete supplier record, RESTful API, integration, automation, ETL, caption maintenance, API key, Org Unit
  • Version/Region: All Assure versions; all regions
  • Important Synonyms:
    • Supplier Contractor Register = Contractor Register = Supplier Register = Supplier/Contractor Register
    • Customer API = Assure Customer API = RESTful API
    • Organisational Unit = Org Unit = Org Unit Reference
    • Caption Maintenance = field configuration = module field setup
    • CDM = Customer Development Manager
    • CSM = Customer Success Manager
    • Supporting items = actions, attachments, notes, reviews, policy links
  • Suggested Embedding Keywords: Supplier Contractor Register API, Assure Customer API contractor, create supplier record API, update contractor register Assure, delete supplier contractor API, automate contractor register, Assure RESTful API supplier, ETL contractor register, caption maintenance API, contractor register reference, API key management Assure
  • Relevant Modules and Cross-Module Implications: This article is scoped to the Supplier Contractor Register module (part of the Contractor Management area) and the Customer API Management area of Assure. The Supplier Contractor Register Organisational Unit (Org Unit) field links records to the broader organisational structure, which underpins record categorisation and access control across all Assure modules. Caption Maintenance configuration (mandatory fields set per customer) applies at the module level and affects what the API requires at runtime. Default reviewers and approvers configured in Assure are applied automatically on record creation via the API. Supporting items such as Actions, which are managed in the core Actions area, cannot be added via this API. The Data Extraction API uses the endpoint /supplier-contractor for extracting Supplier Contractor Register data.

 

Return to top

Related articles