Introduction

The WellcomeMat API provides three core services which enable you to upload, manage, lookup, share, and analyze real estate property video distribution.

• Account API - Manage your account, and sub account users.
• Analytics API - Reporting for media interaction and usage.
• Media API - Upload and manage videos, cover photos, and property details.

Credentials

You must use a valid API Key and Secret to send requests to the API endpoints.

You can get your API key/secret from WellcomeMat’s customer dashboard. Contact your account manager to obtain Test or Production access the API.

Host Environments

• Production: https://www.wellcomemat.com/api/{endpoint}
• Test: https://stage.wellcomemat.com/api/{endpoint}

Requests

Authentication

The WellcomeMat API uses shared secrets for authentication. You must include the key and secret fields in every request to this API.

• key is similar to a login name.
• secret is a shared secret, which should never be released publicly.

HTTP form-data

Every endpoint request should be submitted via HTTP POST with fields submitted as multipart/form-data.

Example Request

curl --location "https://www.wellcomemat.com/api/media/update.php" \
--form "key=$WELLCOMEMAT_KEY" \
--form "secret=$WELLCOMEMAT_SECRET" \
--form "customid=MyExampleCustomMediaId" \
--form "title=To Infinity and Beyond!"

Summary

• Don’t share your secret. Treat it like a password to your account.
• Use only HTTPS-secured communications (Endpoints beginning with https://).
• The API returns request responses in JSON format.

Postman

The WellcomeMat Postman Collection is a great place to get started testing the API and interpreting JSON responses.

You can use the Postman interface to export to a Collection File, or download the exported file here: WellcomeMat‑API‑v11.postman_collection.json