Quickstart

Quickstart#

Introduction#

Vault is a cloud-based DBMS. In addition to the functionality found in other cloud-based DBMS services, the Vault can provide scheduled processing using the same tools that Melissa offers on other platforms.

Features of the Vault include:

  • Cloud-based data storage

  • Flexible user-defined schema

  • Unlimited number of tables

  • Automated data processing (Alerts)

  • User notification of data changes

  • User-scheduled job processing

  • Record transaction tracking

  • Continuous data profiling

  • Duplicate record detection

New to Melissa Cloud Services?#

We highly recommend first time users of our web services to review our Using Melissa Cloud APIs section. It will cover critical topics like:

System Requirements#

  • SSL/TLS 1.2+

Getting Started What Can I Do?#

Vault has many possible uses, but for getting started we will begin with a simple file upload, record select and then add an alert.

Upload a File#

The first step is to upload a file to Melissa servers.

Endpoint#

/V5/API/File/UploadFile/{{fileName}}

Click here to go to the full endpoint documentation.

Try it Now#

  • Upload a File
curl --request POST \
  --url https://vault.melissadata.net/V5/API/File/UploadFile \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: multipart/form-data' \
  --form Options=OverwriteExisting \
  --form TransmissionReference=TEST \
  --form 'List`1[0]=undefined'

Insert FTP Record from File Upload#

Then we need to insert records from the uploaded file.

Endpoint#

/V5/API/Record/InsertRecordsFTP/{tableName}

Click here to go to the full endpoint documentation.

Try it Now#

  • Insert FTP Record from File Upload
curl --request POST \
  --url https://vault.melissadata.net/V5/API/Record/InsertRecordsFTP/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "TableName": "HomesData",
  "FileFormat": "Excel",
  "FileName": "ImportSheets.zip",
  "CompressedFileName": "ExcelSheet1.xlsx",
  "SheetName": "New Addresses",
  "Schema": "",
  "Options": "FirstRowSchema:True,AbortOnAnyError:False",
  "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46",
  "TransmissionReference": "TEST"
}'

Select Records from Table#

Once the records are inserted, we select them from the created table.

Endpoint#

/V5/API/Record/SelectRecords/{{tableName}}/{{primaryKey}}

Click here to go to the full endpoint documentation.

Try it Now#

  • Select Records
curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SelectRecords/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Add Alert#

Finally we add an alert to notify us of any record changes.

Endpoint#

/V5/API/Alert/SelectRecords/{{tableName}}/{{alertName}}/{{primaryKey}}

Click here to go to the full endpoint documentation.

Try it Now#

  • Select Records
curl --request GET \
  --url https://vault.melissadata.net/V5/API/Alert/SelectRecords/HomesData/AddressUpdate/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'
Contents