JavaScript required
We’re sorry, but Coda doesn’t work properly without JavaScript enabled.
Skip to content
Gallery
Apaya - Connector API
About Apaya
What is required from you?
Connector Plugin - Build Overview
Core Library & Plugin Example Installation
Configuration
Available Actions
Exceptions
Plugin Implementation
Inbound Webhook
Testing
FAQs for Integration
Appendix
More
Share
Explore
Configuration
To add a new connector, there is some configuration that needs to be done to allow the solution to run seamlessly. A new Plugin file needs to be created, which implements the IConnectorPlugin interface (see
Appendix B
).
After implementing the missing methods, you need to add the following data:
1.
The needed configuration
(Provider/Merchant/Product) in the GetRequiredConnectorConfiguration function.
The configuration data will be supplied by Apaya. For more detail on configurations see
FAQs for Integration
Refer to
Appendix B
to assist you in implementing the necessary configurations.
Refer to
Appendix F
for example format configuration details
2.
Connector name
(provided by Apaya)
.
3.
Metadata
(Author, Description, and Version for the Nuget Package).
4.
Supported actions
(from the ConnectorAction enum in the Apaya.Connector.Core.Actions namespace in the Apaya.Connector.Core library)
.
Note
: For every action, we need to:
1. Add the action to the list of SupportedActions in the implemented IConnectorPlugin.
2. Define a HandlerProvider for this action.
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
Ctrl
P
) instead.