nam_sor_api_v2 v2.0.15

nam_sor_api_v2

NamSorApiV2 - JavaScript client for nam_sor_api_v2 NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it! This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.15
• Package version: 2.0.15
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.namsor.com/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install nam_sor_api_v2 --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your nam_sor_api_v2 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('nam_sor_api_v2') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/namsor/namsor-javascript-sdk2 then install it via:

    npm install namsor/namsor-javascript-sdk2 --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var NamSorApiV2 = require('nam_sor_api_v2');

var defaultClient = NamSorApiV2.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new NamSorApiV2.AdminApi()
var source = "source_example"; // {String} 
var anonymized = true; // {Boolean} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.anonymize(source, anonymized, callback);

Documentation for API Endpoints

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Documentation for Models

• NamSorApiV2.APIBillingPeriodUsageOut
• NamSorApiV2.APIClassifierOut
• NamSorApiV2.APIClassifierTaxonomyOut
• NamSorApiV2.APIClassifiersStatusOut
• NamSorApiV2.APICounterV2Out
• NamSorApiV2.APIKeyOut
• NamSorApiV2.APIPeriodUsageOut
• NamSorApiV2.APIPlanSubscriptionOut
• NamSorApiV2.APIServiceOut
• NamSorApiV2.APIServicesOut
• NamSorApiV2.APIUsageAggregatedOut
• NamSorApiV2.APIUsageHistoryOut
• NamSorApiV2.BatchCorridorIn
• NamSorApiV2.BatchCorridorOut
• NamSorApiV2.BatchFirstLastNameDiasporaedOut
• NamSorApiV2.BatchFirstLastNameGenderIn
• NamSorApiV2.BatchFirstLastNameGenderedOut
• NamSorApiV2.BatchFirstLastNameGeoIn
• NamSorApiV2.BatchFirstLastNameGeoZippedIn
• NamSorApiV2.BatchFirstLastNameIn
• NamSorApiV2.BatchFirstLastNameOriginedOut
• NamSorApiV2.BatchFirstLastNamePhoneCodedOut
• NamSorApiV2.BatchFirstLastNamePhoneNumberGeoIn
• NamSorApiV2.BatchFirstLastNamePhoneNumberIn
• NamSorApiV2.BatchFirstLastNameUSRaceEthnicityOut
• NamSorApiV2.BatchMatchPersonalFirstLastNameIn
• NamSorApiV2.BatchNameGeoIn
• NamSorApiV2.BatchNameIn
• NamSorApiV2.BatchNameMatchCandidatesOut
• NamSorApiV2.BatchNameMatchedOut
• NamSorApiV2.BatchPersonalNameGenderedOut
• NamSorApiV2.BatchPersonalNameGeoIn
• NamSorApiV2.BatchPersonalNameGeoOut
• NamSorApiV2.BatchPersonalNameIn
• NamSorApiV2.BatchPersonalNameParsedOut
• NamSorApiV2.BatchProperNounCategorizedOut
• NamSorApiV2.CorridorIn
• NamSorApiV2.CorridorOut
• NamSorApiV2.FeedbackLoopOut
• NamSorApiV2.FirstLastNameDiasporaedOut
• NamSorApiV2.FirstLastNameGenderIn
• NamSorApiV2.FirstLastNameGenderedOut
• NamSorApiV2.FirstLastNameGeoIn
• NamSorApiV2.FirstLastNameGeoZippedIn
• NamSorApiV2.FirstLastNameIn
• NamSorApiV2.FirstLastNameOriginedOut
• NamSorApiV2.FirstLastNameOut
• NamSorApiV2.FirstLastNamePhoneCodedOut
• NamSorApiV2.FirstLastNamePhoneNumberGeoIn
• NamSorApiV2.FirstLastNamePhoneNumberIn
• NamSorApiV2.FirstLastNameUSRaceEthnicityOut
• NamSorApiV2.MatchPersonalFirstLastNameIn
• NamSorApiV2.NameGeoIn
• NamSorApiV2.NameIn
• NamSorApiV2.NameMatchCandidateOut
• NamSorApiV2.NameMatchCandidatesOut
• NamSorApiV2.NameMatchedOut
• NamSorApiV2.PersonalNameGenderedOut
• NamSorApiV2.PersonalNameGeoIn
• NamSorApiV2.PersonalNameGeoOut
• NamSorApiV2.PersonalNameIn
• NamSorApiV2.PersonalNameParsedOut
• NamSorApiV2.ProperNounCategorizedOut
• NamSorApiV2.SoftwareVersionOut

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header