API:FAQ:New Wrapper

From Melissa Data Wiki
Revision as of 18:16, 22 September 2023 by Admin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

June 2023 - New Wrapper and Sample Project Release

As of June 2023, Melissa has released new wrapper interfaces with a console-based sample program for all DQT Suite objects. We recommend that you start using the new Wrapper interface to leverage all of the new features.

Note, all of our previous Wrapper Interfaces will still work as intended, but will not include new methods that may have been added with the June 2023 release.

Please use the Powershell (Windows) or Bash (Linux) scripts to generate the Wrapper Library located within the github links below. The new sample projects and wrapper interfaces can be found using the hyperlinks provided below.

Programming Language Support

The following languages are supported with the new wrapper interface and sample projects:
The following languages are no longer supported with the new wrapper interface and sample projects:
  • Perl
  • PHP
  • Ruby
  • SQLServer
  • PLSQL

License String

The new scripts will prompt you for a license string. You may have stored this as an environment variable (MD_LICENSE).
To obtain a license string and get started, please contact a sales representative by:
  • Calling 1-800-MELISSA
  • Emailing Sales@melissa.com

Melissa Updater

By default, the scripts use an additional tool called MelissaUpdater. MelissaUpdater will download the latest release library and data files for each object.
Note, you can disable either the library or data file download by modifying the script prior to running the script.

Releases Browser

Melissa Updater uses the Releases web service on the back end.
You can also get the latest (and previous) releases via the Releases Browser at Data Download Browse.

Github

The wrapper code and sample projects are also available via Git at https://github.com/MelissaData.
The sample projects will also include instructions for using Melissa Updater to keep your binaries and data files up to date.


Programming Language Notes

Java

Quick Notes
  • The Jar file is no longer required but can be generated with the following commands:
javac com/melissadata/*.java
  • This command compiles the java files inside the com/melissadata folder
jar cvf {OUTPUTNAME}.jar com
  • This command will zip up all the files inside the com folder. {OUTPUTNAME} should be renamed as mdAddr.jar, mdEmail.jar, mdPhone.jar, or mdName.jar
  • If a jar file is required by your application, replace both the new jar file and the wrapper library (.dll or .so).
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)


Dotnet

Quick Notes
  • We no longer generate wrapper libraries for DotNet and DotNetCore.
  • Instead, we provide a .cs file that can be included in the project and called directly from the code.
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)


Python3

Quick Notes
  • We no longer generate a wrapper library for Python.
  • Instead, we provide a .py file that can be included in the project and called directly from the Python code.
Wrapper (Git)
Wrapper (Releases Browser)
Sample Projects (Windows)
Sample Projects (Linux)