APIv3 Documentation

Introduction

API root URL: https://tiny.cc/tiny/api/3/

Both HTTPS and HTTP are supported. But HTTPS is recommended.

If you encounter issues using PATCH HTTP method, we support method override for POST calls via X-HTTP-Method-Override header.

Recommended encoding for request's payload - "application/json".
However "application/x-www-form-urlencoded" and "multipart/form-data" are also supported for POST requests. If you want to make PATCH (or other non POST) request with encoding other then "application/json", you should use POST method and set X-HTTP-Method-Override header.

GET-parameters should be "percent-encoded".

Responses are always encoded with "application/json".

All date-time values are in UTC±00:00.

Expired or inactive accounts can't access API. They will get error 1217.

Tinycc API v3 follows the REST API concept.

Tips to keep in mind:

• Postman and RESTED are good starter tools.
• Make use of our Testing Console to troubleshoot calls and visualize the full API requests.
• RESTED browser extension for Google Chrome gives you access to your rested tabs seamlessly as needed.
• Postman is an API platform that helps beginner and intermediate users build and use APIs in a step by step fashion.

After learning to make successful API calls through the above options, attempt to write your own code. An extension can help troubleshoot by separating client-code bugs from network issues.

• Always check HTTP and our internal API error codes (described in API docs). No HTTP response indicates a problem on the client side.
• Play with our Testing Console (launched from top of API docs page). It can give you a feel of what works and what doesn't through the use of examples to display how valid headers should look.
• Observe correct formatting for JSON encoding and "urlencoded" encoding of "long_url." Also, don't forget to encode the "user:password" part of the header with base64 encoding. See the description of HTTP Basic authentication.
• "long_url" should be part of the POST payload. And not simply attached to the URL.

Use PHP exception handling to see actual error messages, like this:

try{
        $surl = $client->shorten($url, $data);
}catch(\Exception $e){
        print $e->getMessage();
}

Set Content-Type header for HTTP requests. So headers part would look like this:

    headers: {
        'Authorization': 'Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
        'Content-Type': 'application/json',
        'Content-Length': message.length
    }

Next steps:

• API Keys - Create, edit, revoke API keys for Branded URL Shortening
• Account info - Get account information like subscription status and usage of account resources
• Shorten URLs - Create short link from long URL
• Read URLs - Get information about short links in your account, search links with a keyword, find links with most clicks etc.
• Edit URLs - Change properties of individual links or groups of links
• Delete URLs - Delete short links from your account
• Click Stats - Read click statistics of short link, reset click counters
• Smart Links - Create and change Smart link routing rules through the APIv3
• Meta Info - API to read lists of allowed parameter values used in Smart Link routing rules
• Group Operations - Limitations of batch operations
• Clint Libraries - Native and third-party client libraries to access Tinycc REST API v3
• Usage Examples - APIv3 usage examples with code samples
• Error Codes - API error codes and error messages