TrustFile Connector Management API

TrustFile Connector Management API

Publisher: Search Engine (Ursa)
Base URL: http://microservice.herokuapp.com/

All custom integration / ETL ought to behave/operate in the exact same way. Adhering to this documentation will allow this

#### Tokens:
* connectorToTFToken: identifies the connector and restricts access to environments / version of TF API the connector is certified for (see below for token usage in header)
* TFToConnectorToken: authorizes Trustfile to access operate the connector micro-service API
* connectionId: identifies and authorizes access to the TF company to push data into. Mapped to a UUID Company Token in database

#### Connector Management API responsibility
* Integrating with TF Items API
* Integrating with host system API, including authorization (typically something like oAuth)
* ETL of sales/refunds/tax/shipping data into TrustFile data model
* Basic management of user data sources: CRUD, enable/disable/status
* Scheduling and load balancing of users data synchronization
* Data integrity. It is the responsibility of the connector micro-service to know what data has been processed by TrustFile.

#### Connector Management API is not responsible for
* User experience
* Branding of experience (aside from the popup for authentication with host system)

#### Hosting / Language
* All connectors will be hosted and operated from the Heroku PaaS
* Language: choose between - Ruby/Node/Java
* DB: Postgres (on heroku)

#### Dates and Timestamps
* Dates are in yyyy-mm-dd format
* Timestamps are in the ISO format: 2015-07-06T22:26:28+00:00
* Timestamps are in UTC +00:00 timezone

#### Configs
Put localization configs (specific to a given environment) into environment variables. Document the required variables in the README.md of the project. https://devcenter.heroku.com/articles/config-vars

#### Security:
API requests except orangez/health are authorized with Header param
```
Authorization: Bearer TFToConnectorToken
```

Available Platforms


DISCLAIMER: These SDKs are generated using publicly available descriptions of APIs that anyone has created. As such there are no guarantees for any of the SDKs below, or that this listing is maintained by or even related to the company it claims to be, unless explicitly specified.

C-Sharp


Portable Class Library Download Customise

A project for creating a C# class library (.dll) that can run on Windows, Silverlight and Windows Phone.

Download Documentation

Objective-C


Cocoa Touch Static Library Download Customise

A foundation framework based template for building static library in Objective-C.

Download Documentation

Java


Android Library (Gradle) Download Customise

A gradle based android library project, which can be used with Android Studio as well as command line based gradle build system.

Download Documentation

Java Library (Eclipse) Download Customise

An eclipse based java library project, which can be used with JRE7.

Download Documentation

Javascript


Angular JS Download Customise

An AngularJS library based on v1.3.0.

Download Documentation

Node.js Download Customise

A Node.js npm package based on Node.js v0.12.4

Download Documentation

PHP


PHP Library Download Customise

A php library based on PHP >= 5.3 and Composer dependency manager

Download Documentation

Python


Python Library Download Customise

A Python library based on Python 2.7, that uses PIP as the dependency manager

Download Documentation

Ruby


Ruby Gem Download Customise

A Ruby Gem based on Ruby >= 2.0.0

Download Documentation

Go


Go Library Download Customise

Go language (v1.4), client library package that is compatible with command line tools as well as the Goclipse IDE.

Download Documentation

All Reviews (0)


There are no reviews at the moment.

Users of this SDK (0)


There are no uses at the moment.

Rating

No Rating

Category

Other

Tags

No Tags