You can consume Cloudmersive APIs in OutSystems by importing the same OpenAPI specs used for the certified Power Automate connectors:

Step 1 — Copy the OpenAPI URL for the product you want

Document and Data Conversion API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20Document%20Conversion/apiDefinition.swagger.json

PDF API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20PDF/apiDefinition.swagger.json

File Processing API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20File%20Processing/apiDefinition.swagger.json

Image Recognition and Processing API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20Image%20Processing/apiDefinition.swagger.json

Data Validation API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20Data%20Validation/apiDefinition.swagger.json

Virus Scan API

https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/Cloudmersive%20Virus%20Scan/apiDefinition.swagger.json

Private Cloud / Private Tenant Cloud: replace the domain name portion of the URL with your private domain or IP.
Public Cloud (other data centers): get the data-center domain from the API Endpoints screen in Cloudmersive Management Center and replace the domain in the URL accordingly.

Step 2 — Import the REST API into OutSystems (from OpenAPI URL)

In Service Studio (OutSystems 11 or ODC):

1. Open your Module (Reactive, Mobile, or Traditional Web).
2. Go to Logic → Integrations → REST.
3. Right-click REST (or use the toolbar) and choose Consume REST API….
4. Select OpenAPI/Swagger → choose URL.
5. Paste the URL you copied in Step 1 → click Fetch / Import.
6. Give the REST API a clear name (e.g., Cloudmersive_PDF).
7. In the operations list, choose Select All (or hand-pick the endpoints you need) → Finish.

That’s it—the methods, structures, and sample schemas are generated in your module.

Step 3 — Configure the base URL (for Private Cloud / other DCs)

After import, you can adjust the Base URL:

• Design-time (Service Studio): open the generated Consumed REST API, and update the URL (root/base URL) so only the domain changes (keep paths as generated).

• Runtime override (Service Center, recommended for per-environment values in OutSystems 11):

  • Deploy your app, then go to Service Center → Factory → eSpaces → YourModule → Integrations → Consumed REST APIs.
  • Edit the Effective URL to use your private or data-center domain. No code change or redeploy needed.

(In ODC, use Application Settings/environment configs to manage the base URL per environment.)

Step 4 — Add authentication (API key)

Cloudmersive uses an API key via HTTP header Apikey.

Option A — Static Header at API level (simple & common):

1. In the Consumed REST API editor, locate Headers (top-level).

2. Add Name: Apikey → Value: reference a configuration value:

   • OutSystems 11: create a Site Property (e.g., CLOUDMERSIVE_API_KEY) and set Value to Site.CLOUDMERSIVE_API_KEY.
   • ODC: create an Application Setting (e.g., CLOUDMERSIVE_API_KEY) and set Value to AppSettings.CLOUDMERSIVE_API_KEY.

Option B — Per-method header (only if you prefer):
Open an individual method → Headers → add Apikey with the same value expression as above.

Tip: Keep secrets out of source by setting them in Service Center → Factory → eSpaces → YourModule → Site Properties (OutSystems 11) or in ODC Application Settings for each environment.

Step 5 — Test the endpoints

1. Open the Consumed REST API in Service Studio.
2. Use the built-in Test pane (available on each method) to send a sample request.
3. For file-upload operations, pass the file Binary Data from an Upload widget or resource, as indicated by the generated inputs.
4. Verify Response (status code and body) and adjust timeouts if your use case involves large documents.

Notes & best practices

• Timeouts: heavy conversions/scans may need a higher timeout (e.g., 120s). Adjust in the Consumed REST API properties.
• Large files: use the generated Binary Data parameters for file content; the importer maps multipart/form-data or binary bodies appropriately.
• Per-environment config: manage Base URL and API key via environment configuration (Service Center or ODC Application Settings) instead of hard-coding.
• Selective import: you can re-run Consume REST API… later to add more operations from the same spec as needed.