Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

SCP-1150 - Getting issue details... STATUS → Related Epic Ticket

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 / Analysis

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

Functional Spec

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

  • Access to SCP functionality: The API provides access to the full range of SCP functionality, allowing developers to interact with SCP in a programmatic way.

  • Standardized protocol: The API adheres to RESTful API design principles, using standard HTTP methods to interact with SCP. This makes it easy for developers to integrate the API into their applications.

  • Request and response format: The API uses JSON for request and response payloads, providing a standard and flexible format for data exchange between the API and client applications.

Technical Spec

The technical specification of the SCP API 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:

  • No labels