Widget Token Validation API

Content

Overview

Widget Token Validation API allows you to generate validation token for your service.

Method

The following REST methods are available:

  • Obtaining validation token of a service.

Requirements

Authorization API Calls
All API call requests to ideabiz.lk require Authorization headers. Please refer the Token Management (http://docs.ideabiz.lk/Getting_Started/Token_Manegment) documentation for Authorization.

Request Header

Authorization: Bearer [access token] 
Accept: application/json

Sample Request Header

Authorization: Bearer a92ba8hjgjhgjh3fa1609cabcd79
Accept: application/json

Validation Token Generation

This allows you to send an SMS from your Web application to one or more addresses (MSISDNs).

URL

https://widget.ideabiz.lk/web/widget/token
Method
GET

Response

{
  "validationToken": "722bc9c531d04fc6bf55854b09f28fcb"
}


Response Codes


200 – Success!
400 – Bad request; check the error message for details
401 – Authentication failure, check your authentication details
403 – Forbidden; please provide authentication credentials
404 – Not found: mistake in the host or path of the service URI
405 – Method not supported: for example you mistakenly used a HTTP GET instead of a POST
500 – The server encountered an unexpected condition. This could be wrong authentication details or limited user permission
503 – Server busy and service unavailable. Please retry the request.

Exceptions

Types

Policy Exception

Message Id start withPL

Server Exception

Message Id start with SV

Exception Body

{
    "requestError": {
        "serviceException": {
            "messageId": "SVC0002",
            "text": " Invalid input value for message part %1",
            "variables": " clientCorrelator Value 12345"
        }
    }
}

Faults

HTTP Respose code 503

Fault Response Body

{
    "fault": {
        "code": "900800",
        "message": "Message Throttled Out",
        "description": "You have exceeded your quota"
    }
}
Last updated on 24th Nov 2017