Concepts

This picture illustrates the concept of an Integration App that has Actions, that are used in Steps in an Integration. All data that is queried and attached is available as StepData during the entire execution of the integration.

Getting Started

Setup Copyl Integration Platform in your API (.Net)

API Reference

All our public APIs are documented here: https://copyl.developer.azure-api.net/apis

https://www.loom.com/share/346ace17a84247fca6a2fc6b454f4cc2?sid=02e98441-a34d-4861-b5a9-2d9993e446c3

Features

How to set up a Datawatcher for effective data monitoring

Integration Connectors

Scripting Support in Integrations

Glossary

How to avoid Vendor Lock-In for your integration solution

Evaluating When to Use the Integration Platform

Authentication and Authorization

Access to all the endpoints requires passing an Authorization header. Two methods of authorization are supported:

1. JWT Token - Pass a JWT as a Bearer token in the Authorization header.
2. API Key - Pass an API key in the Authorization header and provide the EnterpriseId header for verification.

Both methods require correct configuration to ensure successful access. Each approach is described below in detail.

Endpoint: Get All Integrations

• URL: /integrations
• Method: GET
• Description: Retrieves a list of all integrations for the authenticated enterprise.
• Headers:
  • Authorization: Bearer <JWT token> or ApiKey <API Key>
  • Ocp-Apim-Subscription-Key: API management subscription key
  • EnterpriseId: (Required for API Key authentication) The unique identifier of the enterprise in GUID format.

Sample Request

Using JWT Token

GET /integrations HTTP/1.1
Host: [<https://api.copyl.com/ms/Integrations>](<https://copylservicesapi.delightfulflower-7dbed4bd.westeurope.azurecontainerapps.io/Integrations>)
[](<https://copylservicesapi.delightfulflower-7dbed4bd.westeurope.azurecontainerapps.io/>)Authorization: Bearer <JWT Token>
Ocp-Apim-Subscription-Key: <Subscription Key>

Using API Key

GET /integrations HTTP/1.1
Host: [<https://api.copyl.com/ms/Integrations>](<https://copylservicesapi.delightfulflower-7dbed4bd.westeurope.azurecontainerapps.io/Integrations>)
Authorization: ApiKey <Your API Key>
Ocp-Apim-Subscription-Key: <Subscription Key>
EnterpriseId: <Enterprise GUID>

Authorization

Two ways – pre-defined Triggers or ad-hoc Triggers

Pre-defined Triggers

These triggers must be defined in Copyl before you send events to them. This method is best for organizations that plans the integrations before implementing them.