Giter Site home page Giter Site logo

service-integration-sdk's Introduction

service-integration-sdk

Build Status Maven Central

Overview

Represents a collection of utilities meant to facilitate the implementation of custom connectors. A connector is a stand-alone application that handles integration events from the AppDirect marketplace and takes care of the necessary interaction with an external vendor system in order to complete the request.

Essentially a connector is an adapter that allows the marketplace to interact with all external vendor systems in a consistent manner.

For more details, see the documents in our GitHub wiki

Prerequisites

  • Java 8 or higher
  • Your connector application should be implemented using Spring Boot
  • A build tool capable of building and running Spring Boot applications. Although you have several options, in the following instructions we are going to assume that you're using Apache Maven

Features

  • Automatic parsing of incoming market integration events
  • Automatic OAuth authentication of messages using signed fetch
  • Provides you with objects modelling the responses needed to be sent to the marketplace, so that you can specify what response is sent back to the AppDirect marketplace once the processing of a given integration event is complete
  • Automatic OAuth signing of messages to the marketplace

Sample client application

An sample connector implemented with the SDK can be found here Please refer to the documentation of the connector for instructions on building / running it.

Getting Started

To incorporate the SDK into your application please see Getting Started.

Event Handling

Using the SDK enables your application to handle the following AppDirect marketplace integration events. You have full control of the logic that your connector will execute when an integration events. See the Getting Started page for more information on how to implement your integration event handlers.

For more information on AppDirect marketplace integration events, and what each one is used for see the AppDirect marketplace documentation here

Keep in mind that the SDK parses the raw event payloads provided by the AppDirect marketplace (the one described in the AppDirect developer documentation above) and creates an event-specific Java object that is specific to the type of the event. So, as a developer, you would receive a payload containing only the information that is relevant to your event type.

For specific information regarding the different event types and the responses that you need to send back to the AppDirect marketplace when event processing is complete, see here

Domain association

Some products require to be associated to one or multiple domains.

For more details. see the domain association section.

Exposed endpoints

Using the SDK enables several REST points on your connector application. For details, see here

Building the SDK library locally

  • mvn clean javadoc:jar source:jar install

Regular dependencies version update

Use the following to verify that you are using the latest versions of your sdk dependencies

  • mvn versions:update-parent
  • mvn versions:use-latest-releases

service-integration-sdk's People

Contributors

jenkins-appdirect avatar emildafinov avatar gbranchaudrubenovitch avatar jpboudreault avatar ruma-nair avatar davidchau avatar ian-beckles avatar appdirect-opensource avatar kais-ad avatar fedesassone avatar gjacquet avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.