Custom Connector
TimeZoneDB Connector
Global
The TimeZoneDB Connector provides access to time zone data — supported time zones, local time details, and time conversions between zones. It acts as a proxy supporting listing time zones, retrieving local time data, and converting timestamps between time zones, with JSON and XML response formats.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the TimeZoneDB Connector.
- listTimeZones. Retrieves a list of supported time zones, optionally filtered by country or zone name.
- getTimeZone. Retrieves local time data by zone, position, city, or IP (IP lookup requires a premium plan).
- convertTimeZone. Converts a Unix timestamp between two time zones.
Documentation
Detailed Integration Documentation
List Time Zones Retrieval
| Action | listTimeZones |
|---|---|
| Purpose | Retrieves a comprehensive list of supported time zones, optionally filtered by country code or zone name. Useful for building time-zone selection interfaces. |
| Parameters | Required: key – your API key (register at TimeZoneDB). Optional: format (json/xml, default xml), country (ISO 3166 code, e.g. US), zone (name filter, supports wildcard *, e.g. America*), fields (comma-separated fields). |
| Configuration | Configure the base URL via CONNECTOR_ENV_TIMEZONEDB_BASE_URL. |
| Output | Successful: JSON/XML with status, message, and zones array (countryCode, countryName, zoneName, gmtOffset, dst, timestamp). Failure: status ERROR with message (e.g. invalid API key). |
| Workflow example | Execute listTimeZones with key and optional country=US, then populate a time-zone selection dropdown. |
Get Time Zone Retrieval
| Action | getTimeZone |
|---|---|
| Purpose | Retrieves detailed local time data by time zone, geographic position, city, or IP address (IP lookup requires a premium plan). |
| Parameters | Required: key, by (zone | position | city | ip). Optional: format, callback (JSONP), fields, zone (if by=zone), lat/lng (if by=position), country/region/city (if by=city), ip (if by=ip). |
| Configuration | Configure the connector with the correct base URL. |
| Output | Successful: JSON/XML with countryCode, countryName, regionName, cityName, zoneName, abbreviation, gmtOffset, dst, zoneStart, zoneEnd, nextAbbreviation, timestamp, formatted. Failure: status ERROR (e.g. invalid time zone). |
| Workflow example | Execute getTimeZone with key, by=zone, zone=America/New_York, then use the local time and DST status for scheduling or display. |
Convert Time Zone Retrieval
| Action | convertTimeZone |
|---|---|
| Purpose | Converts a Unix timestamp between two time zones, enabling applications to display or calculate time differences across zones. |
| Parameters | Required: key, from (source zone/abbreviation), to (destination zone/abbreviation). Optional: format, time (Unix timestamp, default current UTC). |
| Configuration | Configure the connector with the correct base URL. |
| Output | Successful: JSON/XML with fromZoneName, fromAbbreviation, fromTimestamp, toZoneName, toAbbreviation, toTimestamp, toFormatted, offset. Failure: status ERROR (e.g. invalid time zone). |
| Workflow example | Execute convertTimeZone with key, from=America/New_York, to=Europe/London, and optional time, then use the offset for time-difference calculations. |
Example Workflow: Time Zone Selection and Conversion
| Retrieve supported time zones | Use listTimeZones with key and optional country=US to fetch available zones. |
|---|---|
| Query local time | Execute getTimeZone with by=zone and zone=America/New_York to display local time. |
| Perform conversion | Use convertTimeZone with from=America/New_York, to=Europe/London, and optional time for a scheduling or global-time display. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.