Accessing API Endpoints in Signals Research Suite (SRS)

Keywords:
API, API Key, Signals Data Factory, Signals Notebook, API Documentation, Endpoints

Introduction: This article provides guidance on accessing and using the API endpoints available in the Signals Research Suite (SRS) product. These APIs enable integration and automation of workflows within the SRS platform.

Overview: The Signals Research Suite (SRS) provides the following API endpoints for integration and automation:

• Signals Data Factory Public API: For managing data factory-related operations.
• Signals Notebook API: For interacting with Signals Notebook to manage experiments, data, and workflows.
• Signals Data Factory Primary API: For accessing the primary API documentation for the Signals Data Factory.

Process Steps:

1. Log in to the Signals Research Suite (SRS) platform.
2. Navigate to Home Page > Configuration > System Settings > API Key to retrieve your API key.
3. Use the API key to authenticate and access the API endpoints listed below.
4. Replace <Customer URL> in the endpoint URLs with your customer-specific subdomain.

API Endpoints:

• Signals Data Factory Public API Documentation:
  https://<Customer_URL>/datafactory/api/v1/apidocs
• Signals Notebook API Documentation:
  https://<Customer_URL>/docs/extapi/swagger/index.html#/
• Signals Data Factory Primary API Documentation:
  https://<Customer_URL>/datafactory/apidocs

Authentication:

• All API requests require authentication using the API key.
• Include the API key in the request headers as follows:
  Authorization: Bearer <API_KEY>
• Replace <API_KEY> with your actual API key.

Additional Documentation:

• For detailed API usage and examples, refer to the respective API documentation links provided above.
• For troubleshooting or support, contact your system administrator or the Revvity support team.