Skip to content
FFicanex

The basics

API Integration Overview

In this section, you will learn how to make an API call. We will be using the ReturnProvinces request (List the provinces) as our example.

Within each request page, there is a Try it tab which allows you to test that request. Simply enter your Web Service Key to test the different requests.

  1. 1

    Locate Your Web Service Key

    On the FI Portal, open your Financial Institution’s page. The key is in the Overview section.

    Keep it private. Anyone who has it can make requests on behalf of your Financial Institution.

  2. 2

    Build the Request Address

    Start with the request address. Add a question mark, followed by strAtmServiceKey and your key.

    Example address. Replace the highlighted YOUR_KEY with your key

    https://api.ficanex.ca/service/json/ReturnProvinces?strAtmServiceKey=YOUR_KEY

    operationparametervalueYOUR_KEY replace with your keyThe first parameter follows ?, and each additional parameter follows &.

    This request returns the list of provinces.

  3. 3

    Send the Request from a Browser

    Paste the address into your browser’s address bar and press Enter. The response is formatted as JSONA standard format for organizing data as simple name-and-value pairs inside curly brackets.THE EXCHANGE sends responses in JSON, and all examples on this site use it.: names and values inside curly brackets.

    Example response
    {  "provinces": [    { "id": 156, "name": "Alberta" },    { "id": 153, "name": "BC" },    { "id": 152, "name": "Ontario" }  ]}
  4. 4

    Search for ATMs

    Change the request name and add its required parameters, each after an &. This request returns the ATMs within 5 kilometres of a postal code.

    Example search. Replace the highlighted YOUR_KEY with your key

    https://api.ficanex.ca/service/json/ReturnAtmSearchByPostalCode?strAtmServiceKey=YOUR_KEY&strPostalCode=V7M2J3&bytRadius=5

    operationparametervalueYOUR_KEY replace with your keyThe first parameter follows ?, and each additional parameter follows &.

    The response includes a count, the number of ATMs found, and a locations list containing the ATMs.