Cloudmersive.®

Getting Started with Cloudmersive and Postman

Step 1 - Import the OpenAPI Specification into Postman

- In Postman click the Import button, or click on File > Import...

- Click on Import From Link

- Paste in the URL from below corresponding to the API that you wish to use from Postman, then click Import.

Image Recognition API

https://api.cloudmersive.com/image/docs/v1/swagger

Document Conversion and Processing API

https://api.cloudmersive.com/convert/docs/v1/swagger

Document AI API

https://api.cloudmersive.com/document-ai/docs/v1/swagger

Currency API

https://api.cloudmersive.com/currency/docs/v1/swagger

OCR API

https://api.cloudmersive.com/ocr/docs/v1/swagger

Barcode API

https://api.cloudmersive.com/barcode/docs/v1/swagger

Security API

https://api.cloudmersive.com/security/docs/v1/swagger

Validate API

https://api.cloudmersive.com/validate/docs/v1/swagger

Video and Media Services API

https://api.cloudmersive.com/video/docs/v1/swagger

Virus Scan API

https://api.cloudmersive.com/virus/docs/v1/swagger

Spam Detection API

https://api.cloudmersive.com/spam/v1/swagger.json

Phishing Detection API

https://api.cloudmersive.com/phishing/v1/swagger.json

Fraud AI API

https://api.cloudmersive.com/fraud-ai/docs/v1/swagger

Data Loss Prevention API

https://api.cloudmersive.com/dlp/v1/swagger.json

Step 2 - Configure your Base URL

By default, when importing the API specs Postman will show the endpoint under your API > Variables > baseUrl:

https://api.cloudmersive.com

This is our North America public cloud endpoint. For Private Cloud, Private Tenant Cloud, or Premium customers you can configure your endpoint by clicking on Edit on the collection:

Now, you can set your endpoint under the Variables tab by setting Current Value; for example, in this case we can set a Private Cloud custom endpoint:



We could also set an API Endpoint from the API Endpoints page in the Management Portal.

You may see a baseUrl of localhost - if this is the case be sure to update it to a valid URL

Step 3 - Configure your API Key

Find the API under Collections, and select the API resource you wish to use. Click on Headers and under Apikey paste in your API Key from the Cloudmersive Management Portal into the Value column.

Step 4 - Configure File Parameters

For APIs that upload files, be sure to configure the type of the parameter as a File, as shown here:

Step 5 - Try it out

Fill in the other parameters under Body. If a parameter is a file, hover over it, and change its type to File and select the file you wish to upload. When ready, click Send to transmit the API call.