This documentation applies to older versions of WSO2 ESB connectors. To find the documentation relevant to the version you are using, select the connector from the WSO2 Connector Store and click Documentation.

All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »


This guide gives basic requirements to implement and publish connectors in WSO2 Connector Store.

Basic Implementation Requirements

1) Firstly decide on which API you will be writing the connector. This can be one of the following.

  • REST-based connectors
  • SOAP-based connectors
  • Java API-based connectors

    Rest based connectors are preferred if the api vendor provides a one.

2) For each connector there needs to be a method called init(). Using this method user should be able to manage authentication with the vendor API.

    This can be a call to the external api or simple setting the access tokens within esb context to be used by other methods. 

More information on writing connectors can be found with WSO2 ESB Documentation

Integration test coverage

All the methods should be covered with integration test with latest released ESB version. Above is to enforced validity of connector functionality periodically and with new ESB product versions.

Images required for publishing

We require the images with following sizes to be used in connector store and developer studio. Image type needs to be PNG.

  1. 580x300
  2. 220x200
  3. 55x47
  4. 25x25

Publishing the connector

Once completed send the pull request to following GIT Repository.

Also create a JIRA under project ESB Connectors.

  • No labels