Business Ads For Free API Help Page

Introduction

Business Ads For Free API is a REST API that uses JSON/XML for data exchange format. To use the API, you need to register as a Business Ads For Free user and obtain an access token. The access token must be sent in a custom header for each HTTP call. The API supports GET,POST,PUT, and DELETE and each call is autheitcated against the custom header present in the call. If no custom header is present or an invalid authorization token in the custom header will return a HTTP 409 response.

API	Description
GET docs/Ads	Get authenticated user ads
GET docs/Ads?user={user}&page={page}	Get all ads posted by a user. user is the user id and page is the page number Each page returns 100 ads. Example: /ads?user=asdf&page=1, where asdf is the user id The client making the request must provide asdf's authorzation token
GET docs/Ads?id={id}	Returns an ad for any user, posted in any country/state/city Example: /ads/12345 (returns an ad whose id is 12345)
GET docs/Ads?hour={hour}&distinct={distinct}	Returns a collection of ads posted in the past number of hours, filtered by a distinct filter Example: /ads?hour=3&distinct=user Filter parameter: user: (distinct user), pic: (distinct user with pic), video: (distinct user with video), true: (distinct ads), false: (all ads) Limited to 100 ads only.
POST docs/Ads	No Documentation Found.
DELETE docs/Ads?id={id}	Delete an ad. The authentication token must match the user id of the ad.
PUT docs/Ads	No Documentation Found.
GET Ads	Get authenticated user ads
GET Ads?user={user}&page={page}	Get all ads posted by a user. user is the user id and page is the page number Each page returns 100 ads. Example: /ads?user=asdf&page=1, where asdf is the user id The client making the request must provide asdf's authorzation token
GET Ads/{id}	Returns an ad for any user, posted in any country/state/city Example: /ads/12345 (returns an ad whose id is 12345)
GET Ads?hour={hour}&distinct={distinct}	Returns a collection of ads posted in the past number of hours, filtered by a distinct filter Example: /ads?hour=3&distinct=user Filter parameter: user: (distinct user), pic: (distinct user with pic), video: (distinct user with video), true: (distinct ads), false: (all ads) Limited to 100 ads only.
POST Ads	No Documentation Found.
DELETE Ads/{id}	Delete an ad. The authentication token must match the user id of the ad.
PUT Ads	No Documentation Found.

Countries

API	Description
GET docs/Countries	Get All supported countries Example: /countries
GET Countries	Get All supported countries Example: /countries

Gallery

API	Description
GET docs/Gallery	Get all images of an authenticated user. Example: /gallery
DELETE docs/Gallery?id={id}	Deletes a user image. Example: /gallery/image_name The image must belong to the user authentication token
POST docs/Gallery	Post a collection of images to authenticated user gallery
GET Gallery	Get all images of an authenticated user. Example: /gallery
DELETE Gallery/{id}	Deletes a user image. Example: /gallery/image_name The image must belong to the user authentication token
POST Gallery	Post a collection of images to authenticated user gallery

Users

API	Description
GET docs/Users	Get authenticated user information
GET docs/Users?user={user}&password={password}	Get an api token for a locally registered user at BusinessAdsForFree Example: /api/users?user=asdf&password=pwd, where asdf is the user id and password is the asdf's password
GET Users	Get authenticated user information
GET Users?user={user}&password={password}	Get an api token for a locally registered user at BusinessAdsForFree Example: /api/users?user=asdf&password=pwd, where asdf is the user id and password is the asdf's password

API	Description
GET docs/Categories	Get all supported categories Example: /categories
GET Categories	Get all supported categories Example: /categories

States

API	Description
GET docs/States	Get all supported US States Example: /states
GET States	Get all supported US States Example: /states

Swagger

API	Description
GET docs/Swagger	No Documentation Found.
GET Swagger	No Documentation Found.

Jobs

API	Description
GET docs/Jobs?job={job}	No Documentation Found.
GET Jobs?job={job}	No Documentation Found.

Cities

API	Description
GET docs/Cities	Get all cities near by autheticated user's location
GET docs/Cities?id={id}	Get all supported cities for a country or US State Example: cities/Illinois
GET Cities	Get all cities near by autheticated user's location
GET Cities/{id}	Get all supported cities for a country or US State Example: cities/Illinois