Skip to content

Using APIs product tour video

Getting started with APIs in Protecht.

Protecht ERM’s REST APIs enable seamless automation, data synchronisation, and integration with your existing systems. Learn how to authenticate, send requests, and chain API calls to manage users, update roles, and streamline workflows, all while maintaining security best practices.

Watch this tour to get started with Protecht’s API capabilities.

 

Book a demo with one of our product specialists today to find out more about APIs in Protecht ERM:

Request a demo

Product tour contents

Access API reference documentation

  • Find API operations, available parameters, and request/response examples
  • Ensure you have the View Web API Docs permission to access the documentation

Identify the API base URL

  • Locate your Protecht ERM API base URL in the API reference docs
  • Use this as the foundation for building API requests

Set up API authentication

  • API requests require basic authentication with a security token
  • Best practice:
    • Create dedicated API user accounts with limited permissions
    • Assign roles specific to API operations (e.g., access control for user data)

Build and send API requests

  • Use tools like cURL or Postman to structure API requests
  • Example: Retrieve a list of users with optional filters to refine results

Execute API operations and process response data

  • Use the Try It Out feature in API docs to test requests
  • API responses return data in JSON format for easy processing

Perform complex actions by chaining API calls

  • Example: Retrieve a list of users → Assign a new role to a specific user
  • Update user roles by modifying API response data and resubmitting it

Validate changes in Protecht ERM UI

  • Cross-check API updates within the system’s Users module to confirm success