LyncMe API Developer Hub
 Back to top

LyncMe API allows you to make and modify most of all features of your branded links . manage domains and access to reports from your application

Get started

We recommend the following approach to develop an application with our API.

Configure your API client

Within your application/script, you can access LyncMe Web API via HTTP protocol. Search for a component able to perform basic HTTP operations, and define GET, POST and DELETE operations in such a way they include following headers:

Content-Type: application/json apikey: YOUR_API_KEY

Authentication

For authentication and using API features you need an API key and API secret. You can find it in your Integrations page Please be noted do not share your API key and secret with anyone.

Authentication key should be sent as Authorization header

Enhance your application

When GET and POST flows are working properly in your LyncMe web client, you can enrich it with further API operations.

For each API operation you want to perform in your application:

  • Include in your application model all object definitions involved (in Models section)
  • Include in your application error model, all of the error object definitions involved (in Errors section).
  • Include in your application web client, the API operation (GET, POST or DELETE), as well with a preliminary check for compatibility between the account and the feature you are going to use.
  • Map API responses to correspondent objects definition
  • Test the operation
  • What the API supports

    Manage your account info
    Manage your branded shorts links
    within your account
    within a specific LyncMe Workspace
    Manage your branded domains
    Manage your tags
    Manage your retargeting scripts

    What the API doesn’t support

    Search for domain names
    Purchase a new branded domain
    Manage your billing/invoicing info

    Resource Group

    Domains

    List domains
    GET/api/domains

    Shows all domains of current user

    Example URI

    GET https://api.lync.me//api/domains
    Request
    HideShow
    Headers
    Content-Type: application/json
    Authorization: your-api-key
    Response  200
    HideShow
    Headers
    Content-Type: application/json
    Body
    [
      {
        "createdAt": "2015-05-31T16:15:00.000Z",
        "hostname": "brand.domain",
        "id": 4,
        "linkType": "increment",
        "redirect404": null,
        "rootredirect": null,
        "segmentKey": null,
        "state": "not_registered",
        "title": "ieuieuieu",
        "updatedAt": "2015-11-16T17:10:48.000Z"}
    ]
    Response  401

    Create a domain
    POST/domains/

    Adds a domain to your lync.me account

    Example URI

    POST https://api.lync.me//domains/
    Request
    HideShow
    Headers
    Content-Type: application/json
    Authorization: your-api-key
    Body
    {
      "hostname": "brand.domain",
      "caseSensitive": false,
      "hideReferer": false,
      "httpsLinks": false,
      "linkType": "random",
      "redirect404": "https://website.com",
      "rootredirect": "https://website.com"}
    Response  200
    HideShow
    Headers
    Content-Type: application/json
    Body
    {
      "state": "not_configured",
      "cloaking": false,
      "id": 13498,
      "hostname": "test22222.com",
      "linkType": "random",
      "rootredirect": "",
      "redirect404": "",
      "UserId": 0,
      "hideReferer": false,
      "caseSensitive": false,
      "setupType": "dns",
      "httpsLinks": false,
      "updatedAt": "2018-09-01T05:48:31.114Z",
      "createdAt": "2018-09-01T05:48:31.114Z"}

    QR Code API

    Generate QR code for URL
    GET/v1/create-qr-code/?size={width}x{height}&data={url}

    We do not provide QR code generation API, but you can use API from goQR.me

    • Headers

      Host: api.qrserver.com

    Example URI

    GET https://api.lync.me//v1/create-qr-code/?size=150x150&data=https:/example.com/
    URI Parameters
    HideShow
    width
    number (required) Example: 150
    height
    string (required) Example: 150
    url
    string (required) Example: https://example.com/
    Response  201
    HideShow
    Headers
    Content-Type: image/png