REST API
REST API is a data source type supported by Pirivision's Port module that connects to web services over the HTTP/HTTPS protocol.
It is ideal for connecting to ERP, MES, cloud platforms, and third-party systems that provide data via a REST endpoint returning JSON or XML — instead of direct database access.
Strengths
| Feature | Description |
|---|---|
| Universal Access | Connect to any service that supports HTTP/HTTPS |
| DB-less Integration | Reach systems with no direct DB access via an API layer |
| Cloud Service Compatibility | Compatible with AWS, Azure, Google Cloud, and SaaS platforms |
| Auth Flexibility | All common auth mechanisms: Bearer token, API Key, Basic Auth |
| Global Headers | Authentication headers automatically added to every query |
| Timeout & Retry | Automatic retry against transient service errors |
| SSL Configuration | SSL verification toggle for internal services using self-signed certificates |
What You Can Do in Pirivision
| Action | Description |
|---|---|
| GET Query | Pull JSON data from an endpoint |
| POST Query | Send a body and receive a response |
| Dynamic Path | Multiple endpoint queries by appending different paths to the base URL |
| Header Management | Define Authorization / API Key headers globally or per query |
| JSON Parse | Map fields from the JSON response into Cartography |
| Ping Test | Verify base URL reachability without establishing a full connection |
When To Use
- Cloud ERP / MES: SAP API Hub, Oracle Fusion, or cloud-based MES REST endpoints
- SaaS Platforms: Production tracking, maintenance management, or quality SaaS apps
- OPC Bridge: OPC-UA / Modbus → REST API converter gateways
- IoT Platform APIs: AWS IoT, Azure IoT Hub, or Thingsboard REST APIs
- Internal Microservices: Pulling data from in-house API gateways or microservice architectures
Connection Requirements
| Information | Required | Default |
|---|---|---|
| Base URL | Yes | — |
| Global Headers | No | — |
| Timeout | No | 5000 ms |
| Retries | No | 3 |
| Proxy | No | — |
| SSL Verify | No | OFF |
Base URL
Base URL must contain only the root address (https://api.example.com). Specific paths are added in Compass.
Guides
| Guide | Description |
|---|---|
| Add REST API Data Source | Create a new REST API connection in the Port module |
| Edit REST API Data Source | Update an existing connection |
| Move Data Source | Move to a different folder |
| Duplicate Data Source | Copy with the same settings |
| Delete Data Source | Remove the data source |