DAL

The Digital Access Layer (DAL) is a communications stream used by computers attached to a network. Computers can request/send information needed to link systems together automatically. This is also known as an Application Program Interface (API) request. Support Agents can also make use of this system to retrieve information to help solve issues for our customers. DAL communications can be individually written to access specific information that may not be easily available through any other means. The tool most useful for DAL communications is called Postman.

Postman Overview & Installation

Postman enables you to create and send API requests. Send a request to an endpoint, retrieve data from a data source, or test an API's functionality. You don't need to enter commands in a terminal or write any code. Create a new request and select Send, and the API response appears right inside Postman. Postman is a Windows and Mac program that is available from the IT4U App Shop:

Open

Open

Workspace setup in Postman

After IT has installed Postman, open it and proceed to set up your personal Workspace.

Within My Workspace, we will:

1. create a Collection

2. Configure Authorization information on the Collection

3. create API requests within the Collection

Step 1: Create a Collection

To create a Collection, click the “New” button towards the top-left of the screen

In the Create New pop-up, click on Collection

Name the collection as you see fit! It will be used to group individual API requests.

Step 2: Configure Authorization information on the Collection

Select the desired Collection from the left-hand pane. In the Authorization tab of the main part of the screen, set the following information

the [token_value] must be replaced with the authorization token/API key unique to a User. Consult this page, https://goeverbright.atlassian.net/wiki/spaces/CX/pages/2954035234 , to pull an API key for a specific user or organization.

Postman is now set up to use for some support searches!

Use Postman to find a Job from a Contract ID Number

When a customer sends in a cancellation form, the only pre-printed identification is the Contract ID Number (homeowner_contract_id) on the top-right of the page. While it might be difficult to read the Homeowner’s signature, the Contract ID can identify the job.

Before starting Postman

• Login to any Org on Engine

After starting Postman

• open the Support DAL collection

• click on “Org/Addr/Name by Contact #”

• copy/paste the Contract ID # into the Value

• click the Send button to send the request

Use Postman to find an Org/Address/Homeowner from a …

There are a number of items in the Support DAL collection that are used to find a “Org/Addr/Name” (Organization/Address/Homeowner Name) using a number of different identifiers. They are used just like the example above, except with different Keys/Values. Follow the example (above), providing the requested values. More search items will be added to the collection as those items are researched & tested.

Video Instruction on the DAL

Kira met with Rick & Rob to further discuss the DAL: