FAQs

Last updated: March 3rd, 2020

General

What is API key?

API key is the type of authorization key, which is used to send with the request payload of short link to get the response. It is required when we integrate Lnkiy API in our project.
For example: Please refer below screen shot.

What is project key?

Project key is the type of authorization key, which is used to send with the request payload to create deep link. It is required when we integrate Lnkiy Deep Linking API in our project.

How to generate API key?

To generate API key, Login or Sign up on Lnkiy Website then go to dashboard there you will see a tab as "API integration", from there you can generate your own API key.

How to get project key?

To get project key, Login or Sign up on Lnkiy Website then go to dashboard there you will see a tab as "Dynamic Links", from there you have to add your project and get your project specific key.

Till when API key and project key is valid?

For trial version, it's valid for 1 year. To become a premium user please contact us.

How many short URL can be created with one API key?

For trial version, you can create maximum of 50 short URL using one API key. For Premium user it will vary from plan to plan, to get more info please contact us

Will short URL will get expire when API key limit gets over?

No, Your created short URL will still work even if your API key limit gets over.

How to create custom URL through Lnkiy API?

Its very easy to create custom short URL using API key. You just need to send few attributes with the request payload. Attributes are: "shortUrl" : "your Keyword", urlType" : "Custom"

Is the API Key and Project key same?

No, API Key and project Key are different. API Key is used to generate short link using API and project key is used to generate deep link.

Features

How can we check the active or inactive short URL?

You can check active or inactive short URL from Lnkiy dashboard.

How can we deactivate or inactivate a created short URL?

You can deactivate or inactivate short URL, by login into Lnkiy website you can do this.

How to change API key?

Its easy to re-generate API key, Login into Lnkiy website and go to API integration tab. Click on regenerate API key button that all you will have to do.

What happens when API returns null or unexpected error?

If you face any such issues while making an API call, then please contact us with your query.

How to create deep link?

You can create deep link using rest API.

Do we need different keys for different projects?

Yes, for each project you will have different project key.

Do we need to create multiple accounts to implement deep link in multiple projects?

No, under 1 account you can add multiple projects