What is an API?
An API – Application Programming Interface is a set of functions and procedures used for integrating different applications. The APIs are available in both SOAP and REST protocols on 1LINK developer portal.
Who can use the 1LINK Open APIs?
Any Fintech, PSO/PSPs or business wanting to use the 1LINK Open APIs to build new customer experiences can collaborate with 1LINK to take benefit from this open API platform.
How can I request access to APIs available for testing?
To get access to 1LINK’s Developer Portal and use the APIs, the first step is to Sign Up in developer portal. After registration, you will receive an email with an activation link. Activate your account by using provided activation link and you are ready to go!
What are plans?
A plan is collection of API resources or subsets of resources from one or more API. A plan can contain a mixture of HTTP GET, PUT, POST, and DELETE verbs from different APIs or it can contain all the GET verbs from various APIs. A plan can have a common rate limit for all the resources or each resource can have a different rate limit. Rate limits specify how many requests an application is allowed to make during a specified time interval.
Use this Developer Portal to browse the different plans that are available to you and select a plan that is most suitable for your requirements. Some plans have restricted access that you must request access to use. When you submit your request, the organization is notified, the API administrator assesses your request and they might contact you for more details. Other plans are available to use straight away.
How do I register an application?
When you add an application you are provided with a client ID and client secret for the application. You must supply the client ID when you call an API that requires you to identify your application by using a client ID, or a client ID and client secret.
To register an application click on Apps in the main menu and then click on the 'Register an application' link. Once you have provided an application name, description, etc you will be shown your application client ID and client secret.
Make a note of your client secret because it is only displayed once. You must supply the client secret when you call an API that requires you to identify your application by using a Client ID and Client secret. What is Client Id?
What is Client Id?
Client Id is used for the app’s identification.
What is Client-Secret?
“Client secret” is secret and only known to application and server. It is used to authorize a client and get access token.
How can I test an API?
It is possible to test an API from this Developer Portal.
When looking at the details of an API you will see a table of the operations contained in the API. This will show what method they are (GET, POST, PUT, DELETE, PATCH, HEAD or OPTIONS) and what path the Resource uses.
If you click on the Resource you will see more information about it, what parameters it might take, what it returns, what possible return codes it might use and what they mean.
There is also a 'Try' button which enables you to try the Resource out direct from the Developer Portal.
If the API requires a client ID or a client secret for identification then you can specify these at the top of the 'Try' section.
Can I change Client-Secret?
The client secret should be protected at any cost, if secret is compromised, a new one should be generated and apps authorization will be updated accordingly.
How do I reset my application client secret?
Your application client secret is stored encrypted so we cannot retrieve the unencrypted version to tell you the value if you forget it.
You can reset it, which will update the stored value and return the new value to you.
To do that click 'Apps' in the main menu, click on the application in question and then you can click the 'Reset' link in the 'Client Secret' section.
Your new secret will be displayed at the top of the page
What endpoint do I need to use for testing?
You can integrate with our environment by registering an application. Sandbox APIs environment will let you test the APIs with your application. The mechanism for making API calls against mock data on the sandbox environment is exactly the same as the one for the live environment, so once your app is tested against sandbox, you can integrate to live environment by changing URLs
Is the data in sandbox real data?
No, the data in sandbox is for testing purposes.
I have a specific question related to a particular API, how do I reach out?
You can post all your questions /suggestions on our API forum page, where you can interact with other developers/experts as well as API experts from 1LINK. Alternatively, you can reach out through the contact us /support ticket page.Support
Do I need a contract to use the 1LINK’s Developer Portal and APIs?
What is the cost of using the APIs?
The APIs listed on the developer portal are available for free based on the subscription plan.
How do I see my API usage?
The numbers of requests, for different APIs, that your application has made are shown on your application page.
Click on 'Apps' in the main menu and then click on your application. Under 'Subscribed Plans' you will see all plans your application is subscribed to. For each API contained in that plan you can see the usage compared to the rate limit of the plan.