API Endpoint Overview

Environment URLs

These are the base environment URLs depending on whether you are testing the API or using it in production.

The certification environment is for testing integrations, and production is for live production requests. The staging environment, like certification, can either be used for testing integrations or if Bluefin pushes new features for the developer to try them out.

As it can be seen, the ShieldConex Management API is hosted on the 4010 port so it is critical to include it in your URL.

Environment Name	Endpoint
Staging environment	`https://portal-staging.shieldconex.com:4010`
Testing/Certification environment	`https://portal-cert.shieldconex.com:4010`
Production environment	`https://portal.shieldconex.com:4010`

In our examples, we exclude these base URLs as they can easily be changed if you are transitioning to another environment.

For example,

POST /api/v1/clients

{
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic Base64(username:password)"
  },
  "body": {
    "name": "Test Client",
    "isActive": false,
    "directPartner": {
      "id": 999,
      "name": "partnerName"
    },
    "contact": {
      "id": 2666,
      "firstName": "WATERFORD",
      "lastName": "Example",
      "email": "[email protected]"
    }
  }
}

API Overview

The following table outlines the REST operations that a partner can access. These API endpoints provide a way to automate and integrate ShieldConex® Manager functionalities directly into your own systems.

Endpoint	GET (Multiple)	GET (Single)	POST (Create)	PATCH (Update)	DELETE
/api/v1/users	✔	✔	✔	✔
/api/v1/partners	✔	✔	✔	✔
/api/v1/clients	✔	✔	✔	✔	✔
/api/v1/templates	✔	✔	✔	✔	✔*

*If a template has been published, it cannot be deleted.