How to connect to AFAS Software
To create a connection with AFAS Software, you have the following steps:
- Create test environment (optional)
- Create a user
- Authorize a connector user
- Create a user group
- Create an app connector
- Add needed GetConnectors and UpdateConnectors
- Create a user token
- Vault Connection Setup
1. Create test environment
This step is optional but for testing purposes it's best to create a new test environment.
- First make sure that no other tasks are being performed on the system at the time when you want to add a new environment.
- Go to: General / Environment / Management / New
- Fill in a name, max 8 characters and first char should be a letter, and select the "Demo environment".
2. Create a user
It is best practice to create a new user for each external application that connects to AFAS Software.
- Go to: General / Management / Authorisation tool
- Next go to: User / New system user
- Fill in the needed fields and make sure your user as an email.
3. Authorise a connector user
We'll need to give this user access to GetConnectors, reports etc.
- Go to: General / Management / Authorisation tool
- Go to the tab User maintenance
- Select the user and go to the tab Authorization
- Select the folder General / Management / Definition / Filters
- Check the radio button Filter active on the bottom of the window
4. Create a user group
In the next step we will be creating an App Connector. As we can only give user groups access, we will need to create new user group (or use an existing one)
- Go to: General / Management / Authorisation tool
- Go to: Group / New or click on the New user group icon
- Complete the fields
- Go to the tab: Group maintenance
- Select the new user group
- Go to the tab: Users in group
- Deselect the Show selected items only check box
- Select the users that you want to put in the group. These are users that are going to use the app and will therefore receive rights to certain connectors
5. Create an App Connector
- Go to: General / Management / App connector
- Click on: New
- Enter the description
- Select the user group in User group
If you go to the general properties of your newly created app connector, you should copy the
API Keyand
Environment Key. We will need this in a later step.
6. Add needed GetConnectors and UpdateConnectors
- Still on the app connector properties screen
- Go to: GetConnectors and allow all Profit GetConnectors
- Do the same for UpdateConnectors
7. Create a user token
- Still on the app connector properties screen
- Go to: User tokens
- Click on New to create a token
Caution: You can only see and copy the token during creation, so make sure to store it somewhere. We'll need this in the next step.
8. Vault Connection Setup
Now that you've created an app connector with the needed permissions, you're ready to fill out your credentials in Vault.