- Cloudmersive Documentation

Node.JS Python C# Java PHP Objective-C Ruby Apex C/C++ cURL Swift JavaScript Go

Run this command to install the SDK:

npm install cloudmersive-validate-api-client --save

Or add this snippet to your package.json:

  "dependencies": {
    "cloudmersive-validate-api-client": "^1.3.9"
  }

var CloudmersiveValidateApiClient = require('cloudmersive-validate-api-client');
var defaultClient = CloudmersiveValidateApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';



var apiInstance = new CloudmersiveValidateApiClient.NameApi();

var input = new CloudmersiveValidateApiClient.FirstNameValidationRequest(); // FirstNameValidationRequest | Validation request information


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.nameValidateFirstName(input, callback);

Run this command to install the SDK:

pip install cloudmersive-validate-api-client

from __future__ import print_function
import time
import cloudmersive_validate_api_client
from cloudmersive_validate_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_validate_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'



# create an instance of the API class
api_instance = cloudmersive_validate_api_client.NameApi(cloudmersive_validate_api_client.ApiClient(configuration))
input = cloudmersive_validate_api_client.FirstNameValidationRequest() # FirstNameValidationRequest | Validation request information

try:
    # Validate a first name
    api_response = api_instance.name_validate_first_name(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NameApi->name_validate_first_name: %s\n" % e)

.NET Framework | .NET Core

Run this command to install the SDK:

Install-Package Cloudmersive.APIClient.NET.Validate -Version 3.2.0

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NET.Validate.Api;
using Cloudmersive.APIClient.NET.Validate.Client;
using Cloudmersive.APIClient.NET.Validate.Model;

namespace Example
{
    public class NameValidateFirstNameExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new NameApi();
            var input = new FirstNameValidationRequest(); // FirstNameValidationRequest | Validation request information

            try
            {
                // Validate a first name
                FirstNameValidationResponse result = apiInstance.NameValidateFirstName(input);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NameApi.NameValidateFirstName: " + e.Message );
            }
        }
    }
}

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.Validate.Api;
using Cloudmersive.APIClient.NETCore.Validate.Client;
using Cloudmersive.APIClient.NETCore.Validate.Model;

namespace Example
{
    public class NameValidateFirstNameExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new NameApi();
            var input = new FirstNameValidationRequest(); // FirstNameValidationRequest | Validation request information

            try
            {
                // Validate a first name
                FirstNameValidationResponse result = apiInstance.NameValidateFirstName(input);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NameApi.NameValidateFirstName: " + e.Message );
            }
        }
    }
}

To install with Maven, add a reference to the repository in pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

And add a reference to the dependency in pom.xml:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

To install with Gradle, add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

And add the dependency in build.gradle:

dependencies {
        implementation 'com.github.Cloudmersive:Cloudmersive.APIClient.Java:v4.25'
}

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.NameApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");

NameApi apiInstance = new NameApi();
FirstNameValidationRequest input = new FirstNameValidationRequest(); // FirstNameValidationRequest | Validation request information
try {
    FirstNameValidationResponse result = apiInstance.nameValidateFirstName(input);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NameApi#nameValidateFirstName");
    e.printStackTrace();
}

Run this command to install the SDK:

composer require cloudmersive/cloudmersive_validate_api_client

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');



$apiInstance = new Swagger\Client\Api\NameApi(
    
    
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\FirstNameValidationRequest(); // \Swagger\Client\Model\FirstNameValidationRequest | Validation request information

try {
    $result = $apiInstance->nameValidateFirstName($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameApi->nameValidateFirstName: ', $e->getMessage(), PHP_EOL;
}
?>

Add the Objective-C client to your Podfile:

pod 'CloudmersiveValidateApiClient', '~> 1.0'

CMDefaultConfiguration *apiConfig = [CMDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Apikey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Apikey"];




CMFirstNameValidationRequest* input = [[CMFirstNameValidationRequest alloc] init]; // Validation request information

CMNameApi*apiInstance = [[CMNameApi alloc] init];

// Validate a first name
[apiInstance nameValidateFirstNameWithInput:input
          completionHandler: ^(CMFirstNameValidationResponse* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling CMNameApi->nameValidateFirstName: %@", error);
                        }
                    }];

Add the Ruby client to your Gemfile:

gem 'cloudmersive-validate-api-client', '~> 2.1.6'

# load the gem
require 'cloudmersive-validate-api-client'
# setup authorization
CloudmersiveValidateApiClient.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 = CloudmersiveValidateApiClient::NameApi.new

input = CloudmersiveValidateApiClient::FirstNameValidationRequest.new # FirstNameValidationRequest | Validation request information


begin
  #Validate a first name
  result = api_instance.name_validate_first_name(input)
  p result
rescue CloudmersiveValidateApiClient::ApiError => e
  puts "Exception when calling NameApi->name_validate_first_name: #{e}"
end

Download and copy the /client folder into your Apex project:

Download Apex Client

SwagNameApi api = new SwagNameApi();
SwagClient client = api.getClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) client.getAuthentication('Apikey');
Apikey.setApiKey('YOUR API KEY');

Map<String, Object> params = new Map<String, Object>{
    'input' => SwagFirstNameValidationRequest.getExample()
};

try {
    // cross your fingers
    SwagFirstNameValidationResponse result = api.nameValidateFirstName(params);
    System.debug(result);
} catch (Swagger.ApiException e) {
    // ...handle your exceptions
}

Install libcurl in your C/C++ project:

libcurl/7.75.0

CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
     curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
     curl_easy_setopt(curl, CURLOPT_URL, "https://api.cloudmersive.com/validate/name/first");
     curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
     curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
     struct curl_slist *headers = NULL;
     headers = curl_slist_append(headers, "Content-Type: application/json");
     headers = curl_slist_append(headers, "Apikey: YOUR-API-KEY-HERE");
     curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
     const char *data = "{\n    \"FirstName\": \"<string>\"\n}";
     curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
     res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);

curl --location --request POST 'https://api.cloudmersive.com/validate/name/first' \
--header 'Content-Type: application/json' \
--header 'Apikey: YOUR-API-KEY-HERE' \
--data-raw '{
    "FirstName": "<string>"
}'

import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\n    \"FirstName\": \"<string>\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.cloudmersive.com/validate/name/first")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("YOUR-API-KEY-HERE", forHTTPHeaderField: "Apikey")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
     guard let data = data else {
          print(String(describing: error))
          semaphore.signal()
          return
     }
     print(String(data: data, encoding: .utf8)!)
     semaphore.signal()
}

task.resume()
semaphore.wait()

XHR | jQuery

This code snippet uses the built-in JavaScript XHR request capability

var data = JSON.stringify({
     "FirstName": "<string>"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
     if(this.readyState === 4) {
          console.log(this.responseText);
     }
});

xhr.open("POST", "https://api.cloudmersive.com/validate/name/first");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Apikey", "YOUR-API-KEY-HERE");

xhr.send(data);

var settings = {
     "url": "https://api.cloudmersive.com/validate/name/first",
     "method": "POST",
     "timeout": 0,
     "headers": {
          "Content-Type": "application/json",
          "Apikey": "YOUR-API-KEY-HERE"
     },
     "data": JSON.stringify({
          "FirstName": "<string>"
     }),
};

$.ajax(settings).done(function (response) {
     console.log(response);
});

package main

import (
     "fmt"
     "strings"
     "net/http"
     "io/ioutil"
)

func main() {

     url := "https://api.cloudmersive.com/validate/name/first"
     method := "POST"

     payload := strings.NewReader(`{
    "FirstName": "<string>"
}`)

     client := &http.Client {
     }
     req, err := http.NewRequest(method, url, payload)

     if err != nil {
          fmt.Println(err)
          return
     }
     req.Header.Add("Content-Type", "application/json")
     req.Header.Add("Apikey", "YOUR-API-KEY-HERE")

     res, err := client.Do(req)
     if err != nil {
          fmt.Println(err)
          return
     }
     defer res.Body.Close()

     body, err := ioutil.ReadAll(res.Body)
     if err != nil {
          fmt.Println(err)
          return
     }
     fmt.Println(string(body))
}

Walkthrough Video