Retrieve my connection credentials


My API connection credentials

What credentials I need? How will I get them?

After your account creation, you can connect to your account portal to retrieve your API access credentials:

  1. Your OAuth2 Client App credentials. You can create your Client App as soon as your account is created (you don't need account activation for that)
  2. Your API Key. You will need to activate your account in order to get a valid API Key.

You will need both to access the API. Refer to the Security section for full details about your OAuth2 Client App credentials and API Key and how to use them.

Retrieve my credentials

Connect to you Account portal:

Staging url

https://myaccount.staging.smartdocflow.com/

Production url

https://myaccount.smartdocflow.com/

See create account section if you don't have an account yet.

Your account home page displays 2 sections with your API access credentials:

  1. Top section with your OAuth2 Client App credentials
  2. Bottom section with your API Key value
    image.png

The first time you login, you won't have credentials yet.
Note that in staging environment only, you will have a default API key generated for you for testing purposes even if your account is not activated yet.

Retrieve my OAuth2 App client

You will need to create your OAuth2 client by clicking the Create button API calls.
image.png
Once created, your credentials are assigned to you and you can start using them in your API calls (see example here).
image.png
Note that these credentails are saved in your account and shown automatically everytime you login. You won't have to create the client again.

For more details about OAuth2 and how to use your Client App credentials see OAuth2 section

Retrieve my API Key

Your API Key is tied to your account Subscription. It is assigned automatically to you as part or your Organization license.
The value is automatically displayed on your Account portal.
image.png
For more details about how to use your API Key see API Key section

Need help?
Contact our Support