Augmentink API

Using the Augmentink ADS API, developers can integrate our on-demand local ADS platform into their applications. The API is designed to allow application developers to check prices, schedules, book a ADS, then follow updates on that ADS till completion.

Overview

To get started using the Augmentink ADS API:

  • Signup for a developer account
  • Read some documentation
  • Generate a test environment API key
  • Start making requests against the API at:
    http://api.augmentink.com/
  • Check out this technical walkthrough of our API

Using the API:

  • Request a ADS Request
    POST /v1/
    
  • Evaluate whether the Requestd price and ADS estimate meets your needs
  • Create a ADS
    POST /v1/
    
  • Poll your newly created ADS to follow the status of your ADS
    GET /v1/
    

When you're ready to start doing real deliveries:

  • Fill out the registration form
  • Provide payment details
  • Retrieve your live mode API key

Basics

Our API is REST based. This means:

  • It make use of standard HTTP verbs like GET, POST
  • Uses standard HTTP error responses to describe errors
  • Authentication is specified with HTTP Basic Authentication

All requests use standard query encoding.

POST data should be encoded as standard application/x-www-form-urlencoded

All our responses are in JSON.

Authentication

The Augmentink API requires authentication by HTTP Basic Auth headers. Your API key should be included as the username. The password should be left empty.

Most of the endpoints provided in the Augmentink API are in relation to a specific customer. You'll need to provide your customer id and include it in the URL.


key : {your api key}
token: {you api Token}

Responses

The Augmentink API uses HTTP status codes to indicate the status of your requests. This includes successful and unsuccessful responses.

Responses will also include JSON formatted details for further details.

  • 400: Bad Request: You did something wrong. Often a missing argument or parameter.
    {"code":400,"Message":"Bad Request: You did something wrong. Often a missing argument or parameter"}
  • 200 - OK: Everything went as planned.
    {"code":200,"response":{"width":"600","height":"400","pageName":"yourpagename","video":"0","carousel":"0","icon":null,"meta":null}}
  • 403: unauthorized access
    {"code":403,"Message":"unauthorized access"}
  • 404: Not Found
    {"code":404,"Message":"Not Found"}

Errors

Error responses include details about what went wrong.

{"code":400,"Message":"Bad Request: You did something wrong. Often a missing argument or parameter"}

Versioning

Versioning allows us to provide developers a consistent experience. We provide two levels of versioning:

  • Resource: All endpoints are prefixed with a version such as /v1. This version refers to the overall layout of the endpoints and response standards.

Endpoints

Get a ADS Request

The first step in using the Augmentink API is get a Request on a ADS. This allows you to make decisions about the appropriate cost and availability for using the Augmentink platform, which can vary based on distance and demand.

A ADS Request is only valid for a limited duration. After which, referencing the Request while creating a ADS will not be allowed.

POST /v1/

lat="contain latitude of location"
log="contain longitude of location"

You'll receive a ADSRequest response.

Create a ADS

POST /v1/

name : name/title of business 
lat : contain latitude of location
lng : contain longitude of location
category : contain  Category of Business
address : address of business
email : business Email
act:addpage
icon:icon url
meta:can contain json or string which you want to get in response

Once a ADS is accepted, the ADS fee will be deducted from your account.

Providing the previously generated Request id is optional, but ensures the costs and etas are consistent with the Request.

Update Video and slide to page

POST/v1/
id : pageId
video: Viedo File
carousel: array of images name with { images}
act:update 

List ADS

List all business according to Loaction

GET /v1/
lat: contain latitude of location
lng: contain longitude of location
act:nearby

Retrieve a business details

Retrieve updated details about a ADS.

GET /v1/

pageid : a unique page id of business which can be found on {nearby} action 
did:{divice id} 0 for app and 1 for web
act:pageDetail

Returns: ADS Object