API

RecordPoint makes available an API for your teams to enhance our application. We use Swagger to document the functionality. Swagger is an interactive API documentation tool that enables users to explore and test API endpoints. By leveraging Swagger, users with the necessary technical skills can access the functionality of our application to build their own connectors, workflows, ingestions, or add-ons tailored to their teams' requirements.

This guide provides an overview of how to use Swagger to interact with the API and integrate it into your custom development efforts.

Accessing Swagger API Documentation

1. Navigate to the API Documentation
   Open the following URL in your web browser:
   Swagger UI

2. Understanding the Interface
   The Swagger UI presents a categorized list of available API endpoints. Each section corresponds to a different set of functions, such as file management, workflow automation, and ingestion processes.

3. Authenticating with the API

   • Some endpoints require authentication before use.

   • Look for an Authorize button at the top of the page.

   • Enter your API key or OAuth credentials as required.

Exploring API Endpoints

1. Finding the Right API
   Browse through the available APIs to locate the endpoints relevant to your integration or workflow needs.

2. Expanding an Endpoint

   • Click on an API endpoint to expand it.

   • View details such as the HTTP method (GET, POST, PUT, DELETE) and required parameters.

3. Testing API Calls

   • Click Try it out to enter sample parameters.

   • Click Execute to send a request to the API.

   • Review the response, including status codes and returned data.

Building Custom Connectors & Workflows

1. Use API Endpoints to Automate Workflows

   • Identify key endpoints needed to fetch, create, update, or delete records.

   • Automate processes such as record ingestion, metadata enrichment, or compliance tracking.

2. Developing Custom Connectors

   • Use API requests to pull data from external sources and integrate with our system.

   • Sync records, trigger alerts, or process bulk uploads.

3. Enhancing Application Functionality

   • Build add-ons that extend existing capabilities.

   • Implement custom reporting tools or integrate with third-party platforms.

Best Practices for API Integration

• Follow API Documentation – Ensure that you review request formats, authentication requirements, and rate limits.

• Use Sandbox Environments – Test API calls in a controlled environment before deploying them in production.

• Handle Errors Gracefully – Implement error handling to manage issues such as authentication failures, invalid parameters, or timeouts.

• Secure API Credentials – Store authentication details securely and rotate them periodically.