Facility/Geo API V2 consumers details
Owners : Ramesh Varma Kutcherlapati Rahul Singh
| API proxy name | OAS link | Current environment |
|---|---|---|
| smds-geography-search | GeographySearch-API OAS | Pre-Production, Production |
| smds-facility-search | FacilitySearch-API OAS | Pre-Production, Production |
- Please register as a consumer using Stargate and follow the below steps for onboarding fully : Setup Apigee Proxy using Stargate - Routing APIs - Confluence (atlassian.net)
- Create a JIRA ticket: https://maersk-tools.atlassian.net/jira/software/projects/SMDSDVPS/boards/11057
NOTE : We are not API experience team and does not provide 24X7 Support , if your application is Mission critical , we would suggest to check with API Management team .
Your request is only be approved once you provide proper business justification
| Consumer application Name | Consumer application owner | Business Justification | API hit count ( Daily, Monthly , hourly) | Endpoints you are interested in | Does your application Maintain Local Cache? | POC -Dev | FAC/GEO? |
|---|---|---|---|---|---|---|---|
| Tender Tool | User 84014 | GEO IDs retrieval based on RKST Code | 2000-5000 per day | /master-data/geography-search/cities | Production | retrieve geoId details using RKST code. | |
| OOG Automation | User 84014 | GEO IDs retrieval based on RKST Code | 2000-5000 per day | /master-data/geography-search/cities | Production | retrieve geoId details using RKST code. | |
| Quotes Automation Tool | User 84014 | GEO IDs retrieval based on RKST Code | 2000-5000 per day | /master-data/geography-search/cities | Production | retrieve geoId details using RKST code. | |
| Public Tracking Air LCL Consumer | User ab4eb | Show air and LCL bookings for logged in customers on maersk.com | We will implement it that way | Production | |||
| external-api-dcsa-tracking | User cfbb7 | the DCSA Track and Trace API already integrated with SMDS Locations V1 ( operational facilities endpoint ) to retrieve facility address details, hence would like to request the access to V2 | 2.2M per week | /master-data/facility-search/facilities/:geoId | Yes | Production | retrieve facility address details and SMDG/BIC code using geoId or RKST code |
| aLex | User b4793 | aLex is used to author and maintain the commercial contract and around metadata information. The country data is relevant to define the geographical scope of contract and parties involved (at country level). The API will be used to provide lookup for end users and also to get specific country details based in geographical identifier. | < 100 requests per day | /master-data/geography-search/countries | Yes | Prod | Retrieve country dataSearch country summaries |
| rates | User cb60c | Rates api provides pricing based on OD3CP information for booking.As we are currently using AO location api which will decommission soon.Hence we want to test & validate if this api can be useful and we can migrate to new geographical api. | Retrieve maerskRkstCode and location type based on maerskGeoLocationId | ||||
| air-lcl-masterdata-geo-api-srvc | User 6f02b | alcl-md-query-ms provides capability of find UNLOCO by cityName and coutryCode for creating BusinessePartner in CW1. And it also provides query api for other Alice products. | 14.4k per day | Yes | Production | Retrieve City dataSearch City Geography and Facility IATA | |
| lcl-book-to-quote | User 4a8d0 | lcl, less-than-containerload-booking platform, uses locations api to fetch city info based on maerskRkstCode and/or brandCode+cityName+countryName for the purpose of retriving pricing info for customer routes and also for the the placing of booking itself. | Ca 3k/day | /master-data/geography-search/cities/xx | Retrieve City and country data based on maerskRkstCode (geography search api) and also based on brandcode + cityName+countryName (facility search api) | ||
| air-lcl-chassis-geography-consumer-client | User d6f18 | Air-Lcl Chassis services seamlessly integrate and optimize external systems, including TMFF and CW1, within the Maersk ecosystem. As these external systems handle diverse datasets, Chassis efficiently cleans and transforms the data to comply with MIM, which involves converting local time-zones to UTC. Regrettably, the timezone information is unavailable through the aforementioned external integrations, hindering the translation of local times to UTC. Therefore, accessing the geography API becomes imperative to retrieve location details for the provided rkst codes or unlocCodes, bridging this essential gap. | Retrieve timezone information based on maerskRkstCode and unLocCode (geography search api) | ||||
| clm-routing-component | User cbb66 | In NaaS RFQ Translation, we have the need to associate a Maersk route with a customer RFQ line for an ocean product, this is a.o.t. based on Origin Destination in the customers RFQ line. Resolving an associated route, will eventually be managed by a Unified Routing Component when available.This service is to be a temporary proxy against MEPC until the Unified Routing Component becomes available.When resolving a route from MEPC then the returned routes needs be enriched with route code and route direction. The route code and direction can be provided by String Market Management given origin, first load port, last discharge port and destination.All location information from MEPC is provided as GeoIDs. String Market Management requires RKST codes. Today the AO location API is called to make the translation from GeoIDs to RKST codes before calling String Market Management. All fetched location codes are cached.Since the AO location service is being decommissioned, then the request is to use the SMDS location service for the same GeoID to RKST code translation. | <100/Day | GeoID to RKST code translation.to retrive city information based on geoId and maerskRkstCode | |||
| Global Customs Operation(GCO) | User 62289 | In Order to support end customer for the visibility of Port Information like , Port of Loading(ETD), Port Of Discharge(ETD), Place Of Delivery etc, for a given Booking, we depend on portcode/unloc code for given geoId. | Approx. 75k request /day | master-data/geography-search/cities/{geographyId} | Retrieve City Info with UniLoc code, | ||
| CAT | User a1977 | In order to create a Allocation we need location data to create contract for that Origin and Destination. | 500/day | Geography and facility | Yes | Search loaction data based on RKST, name and GeoId | |
| Maersk mobile app | User e38d6 | As part of Commercial / Local Office lookup functionality from Maersk mobile app we consume facilities and offices APIs to get facilities/countries details. | 3k/day | /master-data/facility-search/facilities/ /master-data/facility-search/facilities/{facilityId} /master-data/geography-search/countries | Partially, when App session is active | User ad645 / User a68f3 | Retrieve facility address ,Retrieve country details |
| Commercial Routing | User 2fc64 | Commercial Routing serves as a pilot for TbM to simplify integrations to geography, and facilities for tenant applications, that do not require the elaborate and real-time data exchange of the SMDS EMP Topic, but can instead rely on a pulled snapshot. Such as UI applications, and small microservices to do simple mapping of Geo ID to RKST and timezone lookups. | 5000 daily, in batches. | /facilities/sites/cities/countriesEssentially both https://admiralv2.hosting.maersk.com/stargate/api-management/apis/736 and https://admiralv2.hosting.maersk.com/stargate/api-management/apis/64 | Yes | Production | Cached snapshot of the current available geography on these three levels: countries, cities, facilities. |
| Athena LCL pricing | User 25558 | Need to validate and map between UNLOCODE and RKST during Contracted rate sheet upload in Athena UI | 10000 hits per day | /cities | Planning | User 01123 |
Was this page helpful?