Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Countrylayer Connector
Overview
The Countrylayer Connector facilitates seamless integration providing access to detailed country informationI. This connector acts as a proxy to streamline data retrieval, supporting actions for retrieving all countries, searching by country name, capital, language, currency, region, regional bloc, calling code, or alpha code. It supports filtering to refine responses and handles authentication through an API key.
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Countrylayer Connector.
Supported Integration Action Points
- getAllCountries: Retrieves a list of all available countries.
- searchCountriesByName: Searches for countries by name, with optional full-text search.
- searchCountriesByCapital: Searches for countries by capital city name.
- searchCountriesByLanguage: Searches for countries by official language.
- searchCountriesByCurrency: Searches for countries by official currency.
- searchCountriesByRegion: Searches for countries by region.
- searchCountriesByRegionalBloc: Searches for countries by regional bloc membership.
- searchCountriesByCallingCode: Searches for countries by calling code.
- searchCountriesByAlphaCode: Searches for countries by alpha code.
- ping: Checks the health of the connector service.
Detailed Integration Documentation
Get All Countries
| Operation ID | getAllCountries |
| Endpoint | /all-countries |
| Purpose | Retrieves a list of all available countries, with optional filtering to include specific fields (e.g., name, capital, currencies). Data may be limited based on the subscription plan. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Name
| Operation ID | searchCountriesByName |
| Endpoint | /search-by-name/{name} |
| Purpose | Searches for countries by name, supporting partial or full-text searches, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Capital
| Operation ID | searchCountriesByCapital |
| Endpoint | /search-by-capital/{capital} |
| Purpose | Retrieves country data by capital city name, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Language
| Operation ID | searchCountriesByLanguage |
| Endpoint | /search-by-language/{language} |
| Purpose | Retrieves country data by official language spoken, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Currency
| Operation ID | searchCountriesByCurrency |
| Endpoint | /search-by-currency/{currency} |
| Purpose | Retrieves country data by official currency used, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Region
| Operation ID | searchCountriesByRegion |
| Endpoint | /search-by-region/{region} |
| Purpose | Retrieves country data by region, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Regional Bloc
| Operation ID | searchCountriesByRegionalBloc |
| Endpoint | /search-by-regionalbloc/{regionalbloc} |
| Purpose | Retrieves country data by regional bloc membership, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Calling Code
| Operation ID | searchCountriesByCallingCode |
| Endpoint | /search-by-callingcode/{callingcode} |
| Purpose | Retrieves country data by official calling code, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Search Countries by Alpha Code
| Operation ID | searchCountriesByAlphaCode |
| Endpoint | /search-by-alpha-code/{code} |
| Purpose | Retrieves country data by alpha code, with optional filtering. |
| Parameters |
|
| Output |
|
| Workflow Example |
|
Health Check
| Operation ID | ping |
| Endpoint | /ping |
| Purpose | Checks the health of the connector service. |
| Parameters | None |
| Configuration | No specific configuration required. |
| Output |
|
| Workflow Example |
|
Configuration
To use the Countrylayer Connector, configure the following environment variables:
- CONNECTOR_ENV_COUNTRYLAYER_BASE_URL: The base URL of the Countrylayer API.
- CONNECTOR_ENV_PORT: The port on which the Flask service runs (default: 8081).
Workflow Creation with the Connector
Example Workflow: Country Information Retrieval and Filtering
| Retrieve All Countries |
|
| Search by Name |
|
| Search by Currency |
|
| Search by Region |
|
Pricing
iSolution logo - white - transparent 250 px