API Access Keys
- 1 Minute to read
- Print
- DarkLight
- PDF
API Access Keys
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can securely connect to Planful using the Access keys feature without using your username and password while working on REST APIs. To view the Access Key feature, you must enroll in Planful Webservices, and you can view this feature in your Profile Menu.
Note
You can contact the Planfuls Support team to enable the Access Key feature. Make sure that the admin users have selected the Enable Web Services Access checkbox in your user profile before reaching out to the Planfuls Support team.
You can generate an Access Key and use the same to authenticate yourself before invoking the API. Use the Access ID as Username and Access Key as Password during authentication.
To generate an Access Key, perform the following steps:
- Click on your profile icon on the top right corner of the application.
- Select the Access Keys option, and you can view the Access Keys pop-up.
- Provide a reference name for the access key in the Name field.
- Click Create new access key to generate a new key. You can view the Access Id and Access Key from the pane available below the fields.
- Copy the Access Id and Access Key and save them with you. You cannot view or copy the access key once you close the Access Keys pop-up.
Once you create an Access Key pair, you can use the Actions drop-down and perform the following actions on the respective Access key:
- Recreate - Use this option if you want to recreate a new access key pair with the same access key name.
- Delete - Use this option to permanently delete the access key.
Was this article helpful?