Zippopotam - Ismena website

info@ismena.com

Zippopotam Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Zippopotam Connector is a Flask-based service that providing seamless access to postal zip code and place information for over 60 countries. This connector supports endpoints for retrieving place information by postal code and finding postal codes by city and state, facilitating applications such as form autocompletion and geolocation services.

Integration Overview

This document details the integration points of the Zippopotam Connector, their purposes, configuration requirements, and supported workflows. The connector forwards requests to the Zippopotam, handling JSON responses and supporting CORS for cross-origin requests.

Supported Integration Action Points

getPlaceByPostalCode: Retrieves place information (e.g., city, state, coordinates) for a given country and postal code.
getPostalCodesByCity: Retrieves postal code information for a specified country, state, and city.

Detailed Integration Documentation

Place Information by Postal Code

Action	getPlaceByPostalCode
Purpose	Retrieves place information, including city, state, and geographic coordinates, for a specified country and postal code. Useful for address verification or form autocompletion.
Parameters	Required: country: Two-letter country code (ISO 3166-1 alpha-2, e.g., "US"). Supported countries: AD, AR, AS, AT, AU, BD, BE, BG, BR, CA, CH, CZ, DE, DK, DO, ES, FI, FO, FR, GB, GF, GG, GL, GP, GT, GU, GY, HR, HU, IM, IN, IS, IT, JE, JP, LI, LK, LT, LU, MC, MD, MH, MK, MP, MQ, MX, MY, NL, NO, NZ, PH, PK, PL, PM, PR, PT, RE, RU, SE, SI, SJ, SK, SM, TH, TR, US, VA, VI, YT, ZA. postal_code: The postal code to query (string, e.g., "90210"). Optional: None
Configuration	Ensure the environment variable CONNECTOR_ENV_ZIPPO_BASE_URL is set to https://api.zippopotam.us. No API key is required.
Output	JSON object with: post code, country, country abbreviation places: Array of objects with place name, longitude, state, state abbreviation, latitude Failure: JSON response with HTTP status code (e.g., 404 for not found)
Workflow Example	Execute getPlaceByPostalCode with country=US and postal_code=90210. Process the response to retrieve place details (e.g., city, state, coordinates). Use the data for address verification or geolocation in forms.

Postal Codes by City and State

Action	getPostalCodesByCity
Purpose	Retrieves postal code information for a specified country, state, and city. Ideal for mapping city names to postal codes.
Parameters	Required: country: Two-letter country code (ISO 3166-1 alpha-2, e.g., "US"). state: State or province code/abbreviation (string, e.g., "MA"). city: City name (string, e.g., "Belmont"). Optional: None
Configuration	Ensure the environment variable CONNECTOR_ENV_ZIPPO_BASE_URL is set to https://api.zippopotam.us. No API key is required.
Output	JSON object with: country, country abbreviation, state, state abbreviation, place name places: Array of objects with place name, longitude, latitude, post code Failure: JSON response with HTTP status code (e.g., 404 for not found)
Workflow Example	Execute getPostalCodesByCity with country=US, state=MA, and city=Belmont. Process the response to retrieve postal codes and associated details. Use the data for city-based postal code lookups or form autocompletion.

Workflow Creation with the Connector

Example Workflow: Address Autocompletion

Retrieve Place by Postal Code	Execute getPlaceByPostalCode with country=US and postal_code=90210. Process the response to extract city (Beverly Hills), state (California), and coordinates. Use the data to populate form fields or verify addresses.
Retrieve Postal Codes by City	Execute getPostalCodesByCity with country=US, state=MA, and city=Belmont. Process the response to obtain a list of postal codes (e.g., "02478") and coordinates. Use the data to suggest postal codes in a dropdown or map interface.
Integrate with Forms	Combine both actions to create a dynamic form autocompletion system. Allow users to input either a postal code or a city/state combination, then fetch and display relevant details. Validate user inputs against API responses for accuracy.

This workflow supports applications requiring postal code lookups, address validation, or geolocation services, leveraging the Zippopotam’s extensive country coverage.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event