Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: REST API for developers - AFAS Help Center
Find shared AFAS configurations in our Exchange configuration category.
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client AFAS
- 1.1 Steps
- 2. Subscribing to Entities from AFAS
- 2.1 Steps
- 2.2 General Concept
- 3. Publishing Entity to AFAS
- 3.1 Steps
- 3.2 General Concept
1. Setting up HTTP Client AFAS
1.1 Steps
-
In the Alumio Dashboard, go to Clients → HTTP Clients.
-
Create a new HTTP Client and select AFAS Client as the prototype of the HTTP Client.
-
AFAS has a URL with an environment ID that needs to be filled in along with the Base64 of the AFAS token that you would like to use.
2. Subscribing to Entities from AFAS
2.1 Steps
-
Go to Connections → Incoming, create a new incoming configuration and select AFAS Subscriber as the subscriber.
-
Select the AFAS HTTP Client to use.
-
(Optional) Add any request parameters needed to subscribe to the entity.
-
(Optional) Add a transformer to modify the request parameters into something you need.
2.2 General Concept
AFAS uses a custom connector for using the subscriber. Please fill the Entity based on the connector name in the AFAS application.
Entity
Fill in the connector name that you created in the AFAS application.
Request Parameters
These are the parameters you can provide to get the needed Entity based on the AFAS API Docs. As an example, to get an “Order” that’s dated in the year 2022, you can fill it in as follows:
- “Path” is the path parameter of the url. For example the {id}.
- “Query” is defined set of parameters attached to the end of a url.
For example: URL.com - MediaOptions
Input Transformer
Any transformers set here will be executed after the “Request Parameters” are loaded. This means you can basically add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.
HTTP Client
This refers to the HTTP Client configuration you will use to access AFAS.
3. Publishing Entity to AFAS
3.1 Steps
- Go to Connections → Outgoing, to create a new outgoing configuration and select the AFAS – Entity Publisher as the Publisher.
- Optionally, you can also add any transformers to modify the data into anything you need before submitting it to AFAS.
- Select the AFAS HTTP Client to use.
- Fill in the AFAS connector name with the same one used in the AFAS application.
3.2 General Concept
AFAS uses a custom connector to use the Publisher. Please fill the Entity based on the connector name used in the AFAS application.
Method
You can select the method of Post, Update or Delete to do what you want with the Publisher.
Entity
To fill data using the Alumio AFAS connector, you need to use the Alumio standard pathing and fill the payload with the data you need to add to AFAS, as an example, when we creating an order.
- “Path” is the path parameter of the url. For example the {id}.
- “Query” is defined set of parameters attached to the end of a url.
Example: URL.com - MediaOptions - “Payload” is the data contained within a request.
Alumio will send an API request to AFAS based on the setting
HTTP Client
This is the HTTP Client configuration you will use to access AFAS.