CNSV-CTE-D-FacilityLocator

CNSV-CTE-D-FacilityLocator 1.0.0

0
No votes yet

This Service will cover the functionality for Facility Location using Google Maps API

forum Discuss this API in the forum
production
development
https://api.banamex.com/mx-gcgapi

Paths

/v1/consumer-services/facilities/searchByAddress

post /v1/consumer-services/facilities/searchByAddress
SearchByAddress

Retrieve near by facilities using address

This API is used to retrieve near by ATMs and Branches using address; The scope is public, post-login and entry-point

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string

Client ID generated during application registration

Authorization
Required in header
string

The most recent Authorization token

Accept
Required in header
string

Content-Types that are acceptable for the response

Accept-Language
Optional in header
string

List of acceptable human languages for response

uuid
Required in header
string

Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier

sid
Required in header
string

SessionId sent by Consumer

searchFacilityByAddressRequest
Required in body
object

Request object for searching faciliies by address

SearchFacilityByAddressRequest
Content-Type
Optional in header
string
application/json
200

Success Response

SearchFacilityByAddressResponse
400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
errorUserNotFoundCustomerId is Invalid
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/consumer-services/facilities/searchByAddress
Try this operation
https://api.banamex.com/mx-gcgapi/api/v1/consumer-services/facilities/searchByAddress
content-type
accept
client_id
Authorization
Accept-Language
uuid
sid

/v1/consumer-services/facilities/searchByGeoLocation

post /v1/consumer-services/facilities/searchByGeoLocation
SearchByGeoLocation

Retrieve near by facilities using geolocation

This API is used to retrieve near by ATMs and Branches using geographic coordinates; The scope is public, post-login and entry-point

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string

Client ID generated during application registration

Authorization
Required in header
string

The most recent Authorization token

Accept
Required in header
string

Content-Types that are acceptable for the response

Accept-Language
Optional in header
string

List of acceptable human languages for response

uuid
Required in header
string

Random 128 bit UUID generated uniquely for every request from the Customer, which will represent transaction unique identifier

sid
Required in header
string

SessionId sent by Consumer

searchFacilityByGeoLocationRequest
Required in body
object

Request object for searching faciliies by geoLocation

SearchFacilityByGeoLocationRequest
Content-Type
Optional in header
string
application/json
200

Success Response

SearchFacilityByGeoLocationResponse
400
TypeCodeDetails
errorinvalidRequestMissing or invalid Parameters
errorUserNotFoundCustomerId is Invalid
ErrorResponse
401
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
ErrorResponse
403
TypeCodeDetailsMore Info
erroraccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently
ErrorResponse
500
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
ErrorResponse
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/consumer-services/facilities/searchByGeoLocation
Try this operation
https://api.banamex.com/mx-gcgapi/api/v1/consumer-services/facilities/searchByGeoLocation
content-type
accept
client_id
Authorization
Accept-Language
uuid
sid

Definitions

Request object for searching facilities using address

{
    "type": "object",
    "required": [
        "searchAddressText",
        "searchRadius",
        "facility"
    ],
    "properties": {
        "searchAddressText": {
            "type": "string",
            "description": "Any combination of address' attributes, e.g. street name, city, postal code, etc.",
            "example": "Santa Fe"
        },
        "searchRadius": {
            "type": "integer",
            "description": "Search radius in meters",
            "example": 1000
        },
        "searchDay": {
            "type": "string",
            "description": "Day of the week the facility has to be available",
            "example": "MONDAY",
            "enum": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "searchTime": {
            "type": "string",
            "description": "Time the facility has to be available",
            "example": "09:00"
        },
        "topFiveLocationSearchFlag": {
            "type": "boolean",
            "description": "Flag to retrieve the top five locations",
            "example": false
        },
        "nextStartIndex": {
            "type": "string",
            "description": "Next start index value",
            "example": ""
        },
        "facility": {
            "$ref": "#/definitions/Facility"
        }
    }
}

Request object for searching facilities using geoLocation

{
    "type": "object",
    "required": [
        "searchRadius",
        "facility"
    ],
    "properties": {
        "searchRadius": {
            "type": "integer",
            "description": "Search radius in meters",
            "example": 1000
        },
        "searchDay": {
            "type": "string",
            "description": "Day of the week the facility has to be available",
            "example": "MONDAY",
            "enum": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "searchTime": {
            "type": "string",
            "description": "Time the facility has to be available",
            "example": "09:00"
        },
        "topFiveLocationSearchFlag": {
            "type": "boolean",
            "description": "Flag to retrieve the top five locations",
            "example": false
        },
        "nextStartIndex": {
            "type": "string",
            "description": "Next start index value",
            "example": ""
        },
        "facility": {
            "$ref": "#/definitions/FacilityInformation"
        }
    }
}

Response object for searching facilities using address

{
    "type": "object",
    "required": [
        "facilities"
    ],
    "properties": {
        "facilities": {
            "type": "array",
            "description": "Facilities Information",
            "items": {
                "$ref": "#/definitions/FacilityDetails"
            }
        },
        "nextStartIndex": {
            "type": "string",
            "description": "Next start index value",
            "example": "CqQCEQEAADmTwFWl"
        }
    }
}

Response object for searching facilities using geoLocation

{
    "type": "object",
    "required": [
        "facilities"
    ],
    "properties": {
        "facilities": {
            "type": "array",
            "description": "Facilities Information",
            "items": {
                "$ref": "#/definitions/FacilityDetails"
            }
        },
        "nextStartIndex": {
            "type": "string",
            "description": "Next start index value",
            "example": "CqQCEQEAADmTwFWl"
        }
    }
}

Facility object used in the searchByAddress request

{
    "type": "object",
    "required": [
        "facilityType"
    ],
    "properties": {
        "facilityType": {
            "type": "string",
            "description": "Type of facility to search for",
            "example": "ATM",
            "enum": [
                "ATM",
                "BRANCH",
                "BOTH"
            ]
        }
    }
}

Facility object used in the searchByGeoLocation request

{
    "type": "object",
    "required": [
        "facilityType"
    ],
    "properties": {
        "facilityType": {
            "type": "string",
            "description": "Type of facility to search for",
            "example": "ATM",
            "enum": [
                "ATM",
                "BRANCH",
                "BOTH"
            ]
        },
        "geographicalLocation": {
            "$ref": "#/definitions/GeographicalLocation"
        }
    }
}

Facility object used in the response

{
    "type": "object",
    "required": [
        "facilityName",
        "facilityType",
        "fullAddress",
        "availableTimes",
        "geographicalLocation"
    ],
    "properties": {
        "facilityName": {
            "type": "string",
            "description": "Name of the facility",
            "example": "citiBanamex Plaza El Punto"
        },
        "facilityType": {
            "type": "string",
            "description": "Type of facility to search for",
            "example": "BRANCH",
            "enum": [
                "ATM",
                "BRANCH",
                "BOTH"
            ]
        },
        "fullAddress": {
            "type": "string",
            "description": "The full address of the Facility as it appears on Google Maps",
            "example": "Plaza El Punto, Blvd. Alfredo Del Mazo 727, Torres Científicos, Las Torres, 50120 Toluca De Lerdo, Mex"
        },
        "availableTimes": {
            "type": "string",
            "description": "List of available times",
            "example": "Lunes 9:00-16:00, Martes 9:00-16:00"
        },
        "currentlyOpenFlag": {
            "type": "boolean",
            "description": " Indicates if the facility is currently open",
            "example": true
        },
        "fullPhoneNumber": {
            "type": "string",
            "description": "Phone Number of the facility as it appears on Google Maps",
            "example": "+52 55 1234 5678"
        },
        "geographicalLocation": {
            "$ref": "#/definitions/GeographicalDetails"
        }
    }
}

Geographical Location object in the request

{
    "type": "object",
    "required": [
        "latitude",
        "longitude"
    ],
    "properties": {
        "latitude": {
            "type": "string",
            "description": "Latitude value for the geographical location where facility is located.",
            "example": "19.44841569999999"
        },
        "longitude": {
            "type": "string",
            "description": "Longitude value for the geographical location where facility is located.",
            "example": "-99.182073"
        }
    }
}

Geographical Detail object in the response

{
    "type": "object",
    "required": [
        "latitude",
        "longitude",
        "photoUrl",
        "placeId"
    ],
    "properties": {
        "latitude": {
            "type": "string",
            "description": "Latitude value for the geographical location where facility is located.",
            "example": "19.44841569999999"
        },
        "longitude": {
            "type": "string",
            "description": "Longitude value for the geographical location where facility is located.",
            "example": "-99.182073"
        },
        "photoUrl": {
            "type": "string",
            "description": "URL of the map",
            "example": "https://maps.googleapis.com/maps/api/place/photo?maxwidth=100&photoreference"
        },
        "placeId": {
            "type": "string",
            "description": "Id of the facility according to Google Maps",
            "example": "ChIJvzI2eKT40YER81I9Z4ReZe4"
        }
    }
}
              
{
    "properties": {
        "type": {
            "type": "string",
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "string"
        }
    },
    "required": [
        "type",
        "code"
    ]
}