Getting Started

Welcome to our RESTful API!

Thank you for choosing our service. We are at the beginning of a long journey and if you choose to believe it, you are among of our first fellow travelers. So let’s make it together!

In this document, you get introduced how to create requests and process them in a very easy manner. We would strongly recommend you to read this document carefully and completely and, follow it. Thus you will understand this document easily.

First, it is discussed in general how to create requests and how to retrieve responses. In brief, we do accept ONLY JSON formatting using UTF-8 encoding and responses will have the same structures. Then the available methods are shown and finally, we will tell you our limitations. Please feel free to contact us at any time at [email protected]. We will be glad to hear your feedback.

Get API Keys

Please go and visit my account and get your API Keys. Please ensure that your email address has been confirmed. Otherwise, please confirm it here. API keys consist of a “client id” and a “client secret”. All methods except “add” require having API keys.

Please protect your API keys and NEVER share them with anyone. If you make requests using a wrong client secret, your API keys will be deactivated after 5 times and you need to change your API secret at my account.

Methods

All methods are HTTP POST methods and must have UTF-8 encoding. The base URL for all request is:

The following methods are relative to the base URL:

{  
    "success":true,
    "error":null,
    "data":{  
       "total_length":1, 
       "current_length":1,
       "start":1, 
       "items":[  
          {  
             "id":"gLlK",
             "url_text":"https://github.com/UDight/api",
             "shortened_url":"http://ud.ht/gLlK",
             "clicks":0,
             "date":"2017-02-18 08:30:28 UTC"
          } 
       ]
    }
 } 

{  
    "success":true,
    "error":null,
    "data":{  
       "total_length":12,
       "current_length":2,
       "start":1,
       "items":[  
          {  
             "id":"gLlK",
             "url_text":"https://github.com/UDight/api",
             "shortened_url":"http://ud.ht/gLlK",
             "clicks":0,
             "date":"2017-02-18 08:30:28 UTC"
          },
          {  
             "id":"ud",
             "url_text":"http://udight.com/",
             "shortened_url":"http://ud.ht/ud",
             "clicks":2,
             "date":"2017-02-18 08:27:42 UTC"
          } 
       ]
    }
 }

{  
    "success":true,
    "error":null,
    "data":null
}

Responses

Despite request variables which are subject to vary, UDight provides the same structure of responses for all methods regardless of the method action.

The response format is:

The data format is:

The format of an “item” in array of items is:

The “error” format is:

And errors are:

Sample of Successful Response

{  
    "success":true,
    "error":null,
    "data":{  
       "total_length":12,
       "current_length":2,
       "start":1,
       "items":[  
          {  
             "id":"gLlK",
             "url_text":"https://github.com/UDight/api",
             "shortened_url":"http://ud.ht/gLlK",
             "clicks":0,
             "date":"2017-02-18 08:30:28 UTC"
          },
          {  
             "id":"ud",
             "url_text":"http://udight.com/",
             "shortened_url":"http://ud.ht/ud",
             "clicks":2,
             "date":"2017-02-18 08:27:42 UTC"
          }
      ]
    }
 }

Sample of Error Response

{  
    "success":false,
    "error":{  
     "code":414,
       "description":"This is not a valid url."
    },
    "data":null
 }