Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Calendarific Connector
Overview
The Calendarific Connector provides a RESTful interface to access comprehensive holiday data, including public, bank, local, and religious holidays and observances across over 230 countries and 3,300 states. It is designed to support applications needing accurate and up-to-date holiday information for planning, diversity awareness, or general reference. The connector supports various integration points to retrieve holiday data based on criteria such as country, year, date, or holiday type.
Integration Overview
The Calendarific Connector offers the following integration points to query holiday-related data:
- Get Holidays by Country and Year: Retrieve a list of holidays for a specific country and year.
- Get Holidays by Date: Fetch holidays occurring on a specific date across all countries.
- Get Supported Countries: Retrieve a list of supported countries and their details.
- Get Holidays by Type: Fetch holidays filtered by type (e.g., national, local, religious).
- Get Holidays with Optional Parameters: Retrieve holidays with customizable filters such as location or specific holiday categories.
Detailed Integration Documentation
Get Holidays by Country and Year
Operation ID
getHolidaysByCountryYear
Purpose
Retrieves a list of holidays for a specified country and year with optional filtering.
Input Details
- Query Parameter: api_key (required, string, e.g., baa9dc110aa712sd3a9fa2a3dwb6c01d4c875950dc32vs) – Unique API key for authentication.
- Query Parameter: country (required, string, e.g., US) – Two-letter country code (ISO 3166-1).
- Query Parameter: year (required, integer, e.g., 2023) – The year for which to retrieve holidays.
- Query Parameter: type (optional, string, e.g., national) – Filter by holiday type (e.g., national, local, religious).
Output
Successful: Returns a JSON array of holidays with details such as name, description, date, and type.
- Failure: Returns an HTTP 422 error with a JSON object containing error details if required parameters are missing or invalid.
Workflow Example
- Send a GET request with parameters api_key, country=US, year=2023.
- Parse the JSON response to extract holiday names, dates, and descriptions.
- Use the data to display holidays in a calendar application or for event planning.
Get Holidays by Date
| Operation ID | getHolidaysByDate |
| Purpose | Retrieves holidays occurring on a specific date across all supported countries. |
| Input Details |
|
| Output |
|
| Workflow Example |
|
Get Supported Countries
| Operation ID | getSupportedCountries |
| Purpose | Retrieves a list of all countries supported by the connector. |
| Input Details |
|
| Output |
|
| Workflow Example |
|
Get Holidays by Type
| Operation ID | getHolidaysByType |
| Purpose | Retrieves holidays filtered by a specific type (e.g., national, local, religious). |
| Input Details |
|
| Output |
|
| Workflow Example |
|
Get Holidays with Optional Parameters
| Operation ID | getHolidaysWithFilters |
| Purpose | Provides a flexible integration point to query holidays with customizable filters. |
| Input Details |
|
| Output |
|
| Workflow Example |
|
Workflow Creation with the Connector
Example Workflow: Building a Holiday Calendar Application
Fetch Supported Countries
- Use the getSupportedCountries integration point to retrieve a list of countries.
- Populate a user interface with country options for selection.
Retrieve Holidays by Country and Year
- Use the getHolidaysByCountryYear integration point with parameters api_key, country=US, year=2023.
- Display holidays in a calendar view with details like name, date, and description.
Filter by Holiday Type
- Use the getHolidaysByType integration point with parameters api_key, country=US, year=2023, type=national.
- Highlight national holidays in the application for event planning.
Monitor Connector Responses
- Implement error handling for HTTP 422 or 429 status codes to manage invalid inputs or rate limits.
- Log connector calls and response times to optimize performance.
Pricing
iSolution logo - white - transparent 250 px