...

...

OpenAPI Schema

https://api.truthtechnologies.com/documentation

Description

Sentinel Compliance Platform (SCP) is bundled with several RESTful API’s that are available for both developer and client use. The API enables users to interact with SCP programmatically, providing a way to integrate SCP into custom applications and automating tasks. The proposed documentation was created to provide a way for incoming developers or inquiring clients the ability to learn and use the RESTful API’s effectively.

Summary

...

Sentinel Compliance Platform (SCP) RESTful API’s provides a flexible and powerful way to interact with its platform, allowing developers to automate for automation of tasks, integrate integrating SCP into custom applications, and access accessing SCP functionality programmatically. The API adheres API’s adhere to RESTful API design principles and uses use standard HTTP methods (GET, POST, PUT, DELETE, etc.).

The documentation will primarily focus on the Platform directory. The API’s are segregated into sub directories based off of their functionality in relation to Sentinel Compliance Platform (SCP). These sub directories are the following:

• Account →

  Jira Legacy
  server System JIRA serverId 42235b0b-27fd-3259-9485-eee378348cf8 key SCP-1024

  Accounts, organizations, groups and users who use SCP shall be able to use API’s for administrative and management level tasks.Batch →

  Jira Legacy
  server System JIRA serverId 42235b0b-27fd-3259-9485-eee378348cf8 key SCP-1021

  Authentication →

Sentinel Compliance Platform uses an authentication token to authenticate requests. Each API request requires a token, which is provided via /api/auth endpoint.

• Batch →
  Batch file upload searches and review queue for batches provided through API’s to provide functionality to users.Compliance →

  Jira Legacy
  server System JIRA serverId 42235b0b-27fd-3259-9485-eee378348cf8 key SCP-1025

  Compliance and remediation of searches supported by API’s for users. Access to reporting, monitoring, and annotating compliance.

• Search →
  Jira Legacy

  server	System JIRA
  serverId	42235b0b-27fd-3259-9485-eee378348cf8
  key	SCP-1023

  Conducting compliance searches (individual or organization) for inquires through API access. Compliance search reporting and continuous monitored screenings.

Functional Spec

The functional specification outlines the functionality that the API provides and how it can be used. The following are the key features of the SCP API:

...

1. Documentation shall explain functionality of the API

2. Documentation shall include the path and method of the API

3. Documentation shall include (if applicable) the parameters required for the API

4. Documentation shall include (if applicable) the request body required for the API

5. Documentation shall include the responses back for the particular API

Documentation will be conducted using OpenAPI’s formatting standards, specifically version 3.0 to create a “Swagger Doc”. After some testing we decided a JSON-type document would work best labeled swagger.json.

...

Technical Spec

The technical specification outlines the technical details of the API, including the API path and method, parameters, request body, and responses. The following is a sample technical specification for a SCP API endpoint in JSON:

Example JSON:

"/api/account/{accountId}": {
  "put": {
          "description": "Update an Account",
          "parameters": [
            {
              "name": "accountId",
              "in": "path",
              "required": true,
              "schema": {
                "type": "string"
              }
            },
            {
              "name": "authorization",
              "in": "header",
              "schema": {
                "type": "string"
              }
            }
          ],
          "requestBody":{
            "$ref": "#/components/requestBodies/putAccount"
          },
          "responses": {
            "200": {
              "description": "OK"
            },
            "401": {
              "description": "Unauthorized"
            },
            "503": {
              "description": "Service Unavailable"
            }
          }
        }
    },

OUTPUT (using Swagger Docs):

...

References

https://learning.postman.com/docs/publishing-your-api/documenting-your-api/

...

  },