Postman

What postman is

An API development tool

Built on Electron (basically a browser)

What does postman do?

Provide an interface for interaction with APIs

How can I interact?

Send requests
Test responses
Share collections

REST APIs

REST is acronym for REpresentational State Transfer.

IDX Brokers API is RESTful.

What we care about is that the API uses the normal http codes the same way a browser does

http codes

200s = things went as expected
300s = redirects
400s = issues with the request
500s = server errors

Methods

(Verbs we use)

Get - Read some data
Put - Add some new data
Post - Update some data
Delete - Delete some data
Options - Discover options

postman supports more methods

What we expect back

json

{
    "String":"text",
    "int":123
}

Making an API Request

Required

Endpoint
Authorization

Optional

Url Params

Data Payload

Set Up

Set the environment

This is where we set variables to use

Set Up

Get a collection

This is where we store endpoints to use

Get Data

Returns

Supporting an API

Identify what API calls are involved
Make requests via postman
Check status code and API return are correct

IDX Broker Use Cases

WordPress

facebook

Zapier

CRMs

Postman Can Only Test The Blue

API

http GET

REST Requests

source code

json data

General Trouble Shooting

Identify need API calls

Use postman to make API calls

Verify return is valid

Verify Data is present