Phishing_hunter_api NPM

phishing_hunter_api

PhishingHunterApi - JavaScript client for phishing_hunter_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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 phishing_hunter_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your phishing_hunter_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 PhishingHunterApi = require('phishing_hunter_api');

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

var api = new PhishingHunterApi.HuntingApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHunting(callback);

Documentation for API Endpoints

All URIs are relative to https://api.phishing-hunter.com/v1

Class	Method	HTTP request	Description
PhishingHunterApi.HuntingApi	getHunting	GET /hunting	ハンティング設定の取得
PhishingHunterApi.HuntingApi	postHunting	POST /hunting	ハンティング設定の更新
PhishingHunterApi.ObservationApi	getObservations	GET /observation	監視対象ドメイン一覧の取得
PhishingHunterApi.ObservationApi	postObservationAdd	POST /observation/add	監視対象ドメインの追加
PhishingHunterApi.ObservationApi	postObservationRemove	POST /observation/remove	監視対象ドメインの削除
PhishingHunterApi.ScannerApi	getScanner	GET /scanner	スキャン対象のドメイン一覧の取得
PhishingHunterApi.ScannerApi	postScannerAdd	POST /scanner/add	スキャン対象のドメインの追加
PhishingHunterApi.ScannerApi	postScannerRemove	POST /scanner/remove	スキャン対象のドメイン一覧の削除
PhishingHunterApi.SettingsApi	getApikeys	GET /apikeys	外部サービス設定の取得
PhishingHunterApi.SettingsApi	getNotifySlack	GET /notify	通知設定の一覧を取得
PhishingHunterApi.SettingsApi	postApikeys	POST /apikeys	外部サービス設定の更新
PhishingHunterApi.SettingsApi	postNotifySlack	POST /notify	通知設定の更新
PhishingHunterApi.UserApi	getApikey	GET /apikey	APIキーの一覧を取得
PhishingHunterApi.UserApi	getUsersInfo	GET /users/info	ユーザ情報の取得
PhishingHunterApi.UserApi	postApikeyCreate	POST /apikey/create	APIキーの作成
PhishingHunterApi.UserApi	postApikeyDelete	POST /apikey/delete	APIキーの削除

Documentation for Models

Documentation for Authorization

custom_authorizer

Type: API key
API key parameter name: Authorization
Location: HTTP header

@babel/cli superagent

@infinitebrahmanuniverse/nolb-phi @everything-registry/sub-chunk-2432

1.0.0

1 year ago