Istanbul Metropolitan Municipality Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Istanbul Metropolitan Municipality API Connector facilitates seamless integration with the Istanbul Metropolitan Municipality Open Data Portal API, based on CKAN API version 3. This connector, designed for use in Turkey, enables access to a wide range of municipal datasets, including transportation, urban planning, and public services data. It supports dataset searches, metadata retrieval, and resource access in JSON format, with optional API key authentication for restricted datasets, streamlining data-driven applications for Istanbul’s urban ecosystem.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Istanbul Metropolitan Municipality Connector.
Supported Integration Action Points

packageSearch: Search for datasets using filters and queries.
packageShow: Retrieve details for a specific dataset.
packageList: List all dataset names or IDs.
resourceShow: Retrieve details for a specific resource.
groupList: List all groups.
organizationList: List all organizations.
tagList: List all tags.
userList: List all users.
groupShow: Retrieve details for a specific group.
organizationShow: Retrieve details for a specific organization.
licenseList: List available licenses.

Detailed Integration Documentation

2.1 Package Search Retrieval

Action	packageSearch
Purpose	Searches for datasets (packages) in the Istanbul Open Data Portal using filters like query, facets, or sorting, enabling discovery of datasets such as traffic or public services data.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication via the Authorization header for restricted datasets.
Parameters	Required: None Optional: q (string) – Search query. fq (string) – Filter query. sort (string, e.g., score desc, name asc) – Sorting criteria. rows (integer, default: 10) – Number of results. start (integer, default: 0) – Pagination start. facet (boolean, default: false) – Enable faceting. facet.mincount (integer) – Minimum facet count. facet.limit (integer) – Facet limit.
Output	Successful: Returns a JSON object with: success (boolean) – True. result – Object with count (integer), sort (string), results array of package objects (id, name, title, notes, resources, tags, etc.), and facets. help – API help string. Failure: Returns error details (e.g., success: false, error with type and message).
Workflow Example	Configure the connector with the base URL and optional API key. Execute the `packageSearch` action with `q=traffic` and `rows=10`. Process the response to list relevant datasets for urban mobility applications.

2.2 Package Show Retrieval

Action	packageShow
Purpose	Retrieves detailed information for a specific dataset (package), including resources, tags, and metadata, supporting evaluation for applications like urban planning.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Dataset ID or name. Optional: use_default_schema (boolean) – Use default schema. include_tracking (boolean) – Include tracking data.
Output	Successful: Returns a JSON object with: success (boolean) – True. result – Package object (id, name, title, notes, resources array with id, url, format, etc., tags, extras). help – API help string. Failure: Returns error details (e.g., 404: Dataset not found).
Workflow Example	Execute the `packageShow` action with `id=traffic-flow-dataset`. Review dataset details and resources. Use for preparing data queries or downloads.

2.3 Package List Retrieval

Action	packageList
Purpose	Lists all dataset names or IDs in the portal, providing a quick overview of available municipal datasets.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: limit (integer) – Number of results. offset (integer) – Pagination offset.
Output	Successful: Returns a JSON object with: success (boolean) – True. result – Array of dataset IDs or names (string). help – API help string. Failure: Returns error details.
Workflow Example	Execute the `packageList` action with `limit=20`. Display dataset names for browsing. Use for catalog exploration.

2.4 Resource Show Retrieval

Action	resourceShow
Purpose	Retrieves details for a specific resource within a dataset, such as URL, format, and size, enabling direct data access for applications like real-time traffic monitoring.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Resource ID. Optional: include_tracking (boolean) – Include tracking data.
Output	Successful: Returns a JSON object with: success (boolean) – True. result – Resource object (id, url, format, description, size, created, last_modified). help – API help string. Failure: Returns error details (e.g., 404: Resource not found).
Workflow Example	Execute the `resourceShow` action with `id=resource-id`. Retrieve the resource URL for data download. Use for integrating data into applications.

2.5 Group List Retrieval

Action	groupList
Purpose	Lists all groups in the portal, optionally with details, for thematic organization of datasets like transportation or environment.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: order_by (string, e.g., name) – Sorting field. sort (string, e.g., asc) – Sort direction. limit (integer) – Number of results. offset (integer) – Pagination offset. groups (boolean) – Include groups. all_fields (boolean) – Return full details.
Output	Successful: Returns a JSON object with: success (boolean) – True. result – Array of group names or full group objects (id, name, title, description). help – API help string. Failure: Returns error details.
Workflow Example	Execute the `groupList` action with `all_fields=true`. List groups for thematic navigation. Use for dataset categorization.

2.6 Organization List Retrieval

Action	organizationList
Purpose	Lists all organizations in the portal, optionally with details, representing municipal departments or data providers.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: order_by (string, e.g., name) sort (string, e.g., asc) limit (integer) offset (integer) organizations (boolean) – Include organizations all_fields (boolean) – Return full details
Output	Successful: Returns a JSON object with: success (boolean) – True result – Array of organization names or full organization objects (id, name, title, description, package_count) help – API help string Failure: Returns error details
Workflow Example	Execute the `organizationList` action with `all_fields=true`. List organizations to identify data providers. Use for sourcing specific datasets.

2.7 Tag List Retrieval

Action	tagList
Purpose	Lists all tags used in the portal, enabling keyword-based dataset discovery.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: vocabulary_id (string) – Filter by vocabulary ID all_fields (boolean) – Return full tag details
Output	Successful: Returns a JSON object with: success (boolean) – True result – Array of tag names or full tag objects (id, name, vocabulary_id, state) help – API help string Failure: Returns error details
Workflow Example	Execute the `tagList` action with `all_fields=true`. List tags for keyword searches. Use for filtering datasets by topic.

2.8 User List Retrieval

Action	userList
Purpose	Lists all users in the portal, supporting administrative or community engagement tasks.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: q (string) – Search query for users order_by (string, e.g., name) all_fields (boolean) – Return full user details
Output	Successful: Returns a JSON object with: success (boolean) – True result – Array of user names or full user objects (id, name, fullname, email, display_name) help – API help string Failure: Returns error details
Workflow Example	Execute the `userList` action with `all_fields=true`. Review user details for administrative purposes. Use for community management.

2.9 Group Show Retrieval

Action	groupShow
Purpose	Retrieves detailed information for a specific group, including datasets and metadata, for thematic analysis.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Group ID or name Optional: include_datasets (boolean) include_dataset_count (boolean) include_extras (boolean) include_users (boolean) include_groups (boolean) – Include subgroups include_followers (boolean)
Output	Successful: Returns a JSON object with: success (boolean) – True result – Group object (id, name, title, description, package_count, datasets) help – API help string Failure: Returns error details (e.g., 404: Group not found)
Workflow Example	Execute the `groupShow` action with `id=transportation` and `include_datasets=true`. Review group datasets. Use for thematic data exploration.

2.10 Organization Show Retrieval

Action	organizationShow
Purpose	Retrieves detailed information for a specific organization, including datasets and metadata, to identify data from specific municipal departments.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: id (string) – Organization ID or name Optional: include_datasets (boolean) include_dataset_count (boolean) include_extras (boolean) include_users (boolean) include_groups (boolean) include_followers (boolean)
Output	Successful: Returns a JSON object with: success (boolean) – True result – Organization object (id, name, title, description, package_count, datasets) help – API help string Failure: Returns error details (e.g., 404: Organization not found)
Workflow Example	Execute the `organizationShow` action with `id=municipal-services` and `include_datasets=true`. Review organization datasets. Use for sourcing department-specific data.

2.11 License List Retrieval

Action	licenseList
Purpose	Lists all available licenses for datasets, supporting compliance and data usage clarity.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ISTANBULOPENDATAPORTALAPI_BASE_URL` environment variable. Optionally, provide an API key for authentication.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON object with: success (boolean) – True result – Array of license objects (id, title, url) help – API help string Failure: Returns error details
Workflow Example	Execute the `licenseList` action. Review licenses for compliance. Use for ensuring legal data usage.

Workflow Creation with the Connector

Example Workflow: Urban Mobility Dashboard

Search for Datasets	Use the `packageSearch` action with `q=transport` to find transportation-related datasets. Identify a target dataset ID (e.g., `traffic-flow-dataset`).
Retrieve Metadata and Resources	Execute the `packageShow` action with the dataset ID to review resources. Use the `resourceShow` action to access specific data URLs.
Analyze Group and Organization Data	Use the `groupShow` action with `id=transportation` to explore related datasets. Use the `organizationShow` action to identify municipal department data sources.
Build Dashboard	Integrate data into a GCP-hosted dashboard for real-time traffic insights.

This workflow enables applications to provide users with comprehensive municipal data, enhancing urban planning, transportation management, and public service optimization in Istanbul.

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 Wired for Banking