cloudmersive-phishing-detection-api-client

CloudmersivePhishingDetectionApiClient - the Ruby gem for the phishingapi

Easily and directly scan and block phishing security threats.

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 2.2.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudmersive-phishing-detection-api-client.gemspec

Then either install the gem locally:

gem install ./cloudmersive-phishing-detection-api-client-2.2.0.gem

(for development, run gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cloudmersive-phishing-detection-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cloudmersive-phishing-detection-api-client'

# Setup authorization
CloudmersivePhishingDetectionApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersivePhishingDetectionApiClient::PhishingUrlApi.new

opts = { 
  body: CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest.new # PhishingUrlAdvancedRequest | 
}

begin
  #Use advanced AI detection to determine if a URL is a known phishing threat
  result = api_instance.phishing_url_advanced_post(opts)
  p result
rescue CloudmersivePhishingDetectionApiClient::ApiError => e
  puts "Exception when calling PhishingUrlApi->phishing_url_advanced_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
CloudmersivePhishingDetectionApiClient::PhishingUrlApi	phishing_url_advanced_post	POST /phishing/url/advanced	Use advanced AI detection to determine if a URL is a known phishing threat
CloudmersivePhishingDetectionApiClient::PhishingUrlApi	phishing_url_post	POST /phishing/url	Use AI and deterministic detection to determine if a URL is a phishing threat
CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi	phishing_url_advanced_batch_post	POST /phishing/url/advanced/batch	Accept multiple urls at once to perform lookups to see if the urls are known phishing sites as well as multiple other scans to determine if the URL is a potential phishing threat.
CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi	phishing_url_batch_post	POST /phishing/url/batch	Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.

Documentation for Models

• CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest
• CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequestBatch
• CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponse
• CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponseBatch
• CloudmersivePhishingDetectionApiClient::PhishingUrlRequest
• CloudmersivePhishingDetectionApiClient::PhishingUrlResponse
• CloudmersivePhishingDetectionApiClient::PhishingUrlResponseBatch

Documentation for Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header