Teamogy as a client
In this type of integration, Teamogy invokes communication based on the configured trigger. A typical example of such integration is the connection to the accounting system. In this case, Teamogy connects to the counterparty's server API in the client role.
How does such integration work?
-
In Teamogy, an event occurs that is configured as a trigger to data transfer. For example, that an invoice has acquired APPROVED status in the approval process. Or that the user has marked the required invoices with the EXPORT READY flag. Everything is freely configurable.
-
Teamogy queues the invoice for sending. The first attempt to send usually takes a few seconds. Depending on how the connection to the counterparty server is configured and how the integration template is configured, the output format of the transmitted data (freely configurable, XML or JSON) is compiled.
-
The message is transmitted to the other party in the configured format. The counterparty's response is again written to the exported invoice via the configuration template.
-
If the counterparty's server is not available at the moment, the invoice will be resubmitted at a later time. There are a total of 4 attempts to send within 24 hours. If the fourth attempt fails to send, the invoice is marked with an error.
Teamogy as a server
Teamogy in the role of server
In this type of integration, the communication is invoked by the counterparty (client) who connects to the Teamogy API and sends the request. A typical example of such integration is the connection of an attendance system.
How does such integration work?
-
An event occurs in the counterparty's system that triggers a communication request. For an example of an attendance system, such an event is the registration of the user's arrival (passage through the turnstile)
-
The counterparty system sends a request to Teamoga to register the user's arrival
-
Teamogy replies that he accepted the request.
Available API definitions are described below. These definitions will be expanded on an ongoing basis.
Communication triggering webhook
In this type of integration, Teamogy invokes communication based on the configured trigger by calling the counerparty's webhook. The site receives information about which entity initiated the request and requests Teamogy in the role of server for the requested data.
Teamogy as a client or server over integration service
Requirements for complex integration or integration with a very complex counterparty should be realised using the intermediary integration service. Such an intermediary is usually an integration service (eg well known services as zapier.com, integromat.com) or a tailor-made integration bridge.
