SDKs overview
HelloSalut provides Software Development Kits (SDKs) and client libraries to facilitate integration with its suite of geospatial APIs. These tools abstract the underlying RESTful API calls, handling authentication, request formatting, and response parsing, which can streamline development workflows for developers. The SDKs are designed to interact with HelloSalut's core products, including the Geocoding API, Reverse Geocoding API, Timezone API, and IP Geolocation API. By using an SDK, developers can reduce the boilerplate code required to interact with web services, which is a common benefit of client libraries across API providers like Stripe and Twilio, which also offer SDKs for various languages (Stripe API documentation, Twilio SDKs and Helper Libraries).
The official HelloSalut SDKs are developed and maintained by HelloSalut, ensuring compatibility with the latest API versions and features. Community libraries, while not officially supported, may also exist and can offer alternative approaches or support for additional languages or frameworks. This page focuses on the officially supported SDKs and provides a general overview of how to integrate them into projects.
Official SDKs by language
HelloSalut currently offers official SDKs for four programming languages, addressing a range of development environments. These SDKs are designed to provide idiomatic interfaces for each language, enabling developers to integrate HelloSalut API calls using familiar constructs. Each SDK is maintained to ensure compatibility with the corresponding API endpoints and data models described in the HelloSalut API reference.
| Language | Package Name / Interface | Maturity | Documentation Link |
|---|---|---|---|
| JavaScript | @hellosalut/js-sdk |
Stable | HelloSalut JavaScript SDK documentation |
| Python | hellosalut-python |
Stable | HelloSalut Python SDK documentation |
| PHP | hellosalut/php-sdk |
Stable | HelloSalut PHP SDK documentation |
| Ruby | hellosalut-ruby |
Stable | HelloSalut Ruby SDK documentation |
Installation
Installing HelloSalut SDKs typically involves using the standard package manager for each respective programming language. Each SDK is distributed through official repositories, ensuring that developers can access validated and up-to-date versions. Below are general installation instructions for each officially supported language. For specific version requirements or advanced installation options, refer to the HelloSalut official documentation.
JavaScript
The JavaScript SDK can be installed using npm or yarn, which are common package managers for Node.js and front-end projects.
npm install @hellosalut/js-sdk
# or
yarn add @hellosalut/js-sdk
Python
The Python SDK is available via pip, the Python package installer.
pip install hellosalut-python
PHP
For PHP projects, Composer is the recommended tool for dependency management.
composer require hellosalut/php-sdk
Ruby
The Ruby SDK is available as a gem and can be installed using the gem command.
gem install hellosalut-ruby
Quickstart example
This section provides a quickstart example demonstrating how to use the HelloSalut SDKs for a common task: geocoding an address. These examples assume you have already installed the respective SDK and possess a valid API key, which is required for authentication with all HelloSalut API endpoints. You can obtain an API key by signing up on the HelloSalut homepage.
JavaScript Quickstart (Node.js/Browser)
This example shows how to use the JavaScript SDK to perform a geocoding request.
import { HelloSalutClient } from '@hellosalut/js-sdk';
const apiKey = 'YOUR_API_KEY'; // Replace with your actual API key
const client = new HelloSalutClient(apiKey);
async function geocodeAddress(address) {
try {
const response = await client.geocode.forward(address);
console.log('Geocoding Result:', response.data);
} catch (error) {
console.error('Error during geocoding:', error);
}
}
geocodeAddress('1600 Amphitheatre Parkway, Mountain View, CA');
Python Quickstart
This Python example demonstrates a forward geocoding request using the hellosalut-python library.
from hellosalut import HelloSalutClient
api_key = 'YOUR_API_KEY' # Replace with your actual API key
client = HelloSalutClient(api_key)
def geocode_address(address):
try:
response = client.geocode.forward(address)
print('Geocoding Result:', response.json())
except Exception as e:
print(f'Error during geocoding: {e}')
geocode_address('Eiffel Tower, Paris, France')
PHP Quickstart
The PHP SDK allows for geocoding requests as follows:
<?php
require 'vendor/autoload.php';
use HelloSalut\HelloSalutClient;
$apiKey = 'YOUR_API_KEY'; // Replace with your actual API key
$client = new HelloSalutClient($apiKey);
try {
$response = $client->geocode->forward('Brandenburg Gate, Berlin, Germany');
echo 'Geocoding Result: ' . json_encode($response->toArray(), JSON_PRETTY_PRINT);
} catch (\Exception $e) {
echo 'Error during geocoding: ' . $e->getMessage();
}
?>
Ruby Quickstart
A Ruby example for geocoding an address:
require 'hellosalut-ruby'
api_key = 'YOUR_API_KEY' # Replace with your actual API key
client = HellosalutClient.new(api_key)
def geocode_address(address)
begin
response = client.geocode.forward(address)
puts 'Geocoding Result: '
puts JSON.pretty_generate(response.to_hash)
rescue StandardError => e
puts "Error during geocoding: #{e.message}"
end
end
geocode_address('Colosseum, Rome, Italy')
These examples illustrate the basic pattern for interacting with the HelloSalut Geocoding API using the respective SDKs. The response object typically contains structured location data, including coordinates, address components, and locality information. For detailed API response structures and additional parameters, consult the HelloSalut API Reference.
Community libraries
While HelloSalut provides official SDKs for several popular programming languages, the broader developer community may also contribute open-source client libraries or integrations. These community-driven projects can offer support for additional languages, frameworks, or specialized use cases not covered by the official SDKs. For example, a community library might provide an adapter for a specific front-end framework like React or Vue, or a wrapper for a less common language. The nature and quality of community libraries can vary, and they may not always keep pace with the latest API changes or maintain the same level of support as official SDKs.
Developers interested in leveraging community contributions are advised to search platforms like GitHub or package repositories (e.g., npm, PyPI, Packagist, RubyGems) for projects tagged with "HelloSalut" or "geocoding" that specifically mention integration. It is recommended to evaluate factors such as project activity, documentation quality, license, and community feedback before incorporating third-party libraries into production environments. HelloSalut's official documentation is the authoritative source for supported integration methods and API specifications, ensuring developers can always revert to a validated implementation path.
As of 2026, HelloSalut's documentation primarily highlights its official SDKs. Any community libraries would be discoverable through external developer resources outside of HelloSalut's direct control. Developers should exercise due diligence when using community-maintained tools, verifying their compatibility and security. Community contributions often enhance API ecosystems by offering diverse integration patterns, as seen with other API providers where community engagement leads to a wider array of tools and plugins (Google Maps Platform Libraries).