Subscription Key

Starting from mid 2020, all third party applications NEED to pass subscription key in each of the call's header or in the URL. This will help us understand the API calls and troubleshoot issues specific to a developer.

If you don't pass your subscription key, you'll receive the below error:

{    
"statusCode": 401,
"message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API."
}

 

What is subscription key?

Subscription keys are unique to each of the API product that you subscribe to (Reckon One API/Reckon Accounts Hosted API), which identifies you, the software developer. For every Reckon API product (Reckon One API/Reckon Accounts Hosted API) that you subscribe to, you will be assigned a subscription key. You can find your subscription keys under your profile section in Reckon API Portal (hosted in Azure).

 

How do I access Reckon API Portal (hosted in Azure)?

Go to the Sign in page of Reckon API Portal and login with the email address and password that either we provided you with when you signed up or you'd have created (password) for yourself.

 

What are my login details for the Reckon API Portal (hosted in Azure)?

  • The email address is the one you provided us with your application form.
  • The password is either provided by us if we created the account for you or you created it if we invited you to join.
    If you can't remember your password, then click on "Forgot your password?".
  • If you don't have an account, please email our Support team at apisupport@reckon.com and we will send you an invitation link via email.

 

Where can I find my subscription keys?

When you sign up to become our Developer Partner, you would've received an invitation link via an email to sign up for Reckon API Developer Portal (hosted in Azure) or we would have sent your account details where we created your account for you.

 

We subscribe you to the API product(s) that you mention in your application form that you want to develop your integration with and that process assigns subscription keys to you subscription. If you want to subscribe to another Reckon API product (for example: Reckon Accounts Hosted), please email us at apisupport@reckon.com and we will organise it for you.

 

  1.  Login to Azure Portal.
  2. Navigate to your PROFILE (click on the drop-down icon next to your name and click PROFILE.
     
  3. Here you can find your Subscription key. Use Primary key's value in your calls.

 

Example of subscription key in header

Since subscription key is linked with API product (Reckon One API/Reckon Accounts Hosted API), you will need to add the specific subscription key.

 

Below is an example where the subscription key is added to the header:

 

{
"request":
method "GET
url "https://api.reckon.com/R1/cashbooks"
headers name "Ocp-Apim-Subscription-Key"
value name "Authorization"
value "Bearer {{token}}"
name "Host"
value "api.reckon.com"
} 

 

Below is an example where subscription key is added to the URL:

 

var settings = {
"async": true,
"crossDomain": true,
"url": "https://api.reckon.com/R1//{bookid}/templates/estimate?Subscription-Key={Subscription-Key}",
"method": "GET",
"headers": {
"Authorization": "Bearer {token}"
}


How did we do?


Powered by HelpDocs