Giter Club home page Giter Club logo

flex-integration-sdk-js's Introduction

Sharetribe Flex Integration SDK for JavaScript

Use Sharetribe Flex Integration API with ease.

CircleCI

Table of Contents

What is it?

The SDK is the easiest way to interact with Sharetribe Flex Integration API.

It handles groundwork such as authentication, renewing authentication tokens and serializing and deserializing data to and from JavaScript data structures.

This lets you to concentrate on building your integration instead of setting up the necessary boilerplate to communicate with the API.

Installation

Yarn:

yarn add sharetribe-flex-integration-sdk

Usage

const sharetribeIntegrationSdk = require('sharetribe-flex-integration-sdk');

// Create new SDK instance
const integrationSdk = sharetribeIntegrationSdk.createInstance({
  clientId: '<Your Client ID here>',
  clientSecret: '<Your Client secret here>'
});

// Query first 5 listings
integrationSdk.listings
  .query({ perPage: 5 })
  .then(res => {
    // Print listing titles
    res.data.data.forEach(listing => {
      console.log(`Listing: ${listing.attributes.title}`)
    });
  })
  .catch(res => {
    // An error occurred
    console.log(`Request failed with status: ${res.status} ${res.statusText}`);
  });

Client ID and client secret are required to create a new SDK instance. See this article to learn how to get them.

Examples

See the flex-integration-api-examples repository on GitHub.

Documentation

Documentation can be found here.

Changelog

See CHANGELOG.md.

License

Distributed under The Apache License, Version 2.0

flex-integration-sdk-js's People

Contributors

rap1ds avatar bladealslayer avatar lyyder avatar gnito avatar dependabot[bot] avatar kpuputti avatar wontheone1 avatar otterleyw avatar ovan avatar thomasmalbaux avatar sarisaar avatar joekarasek avatar olshanskygotsoils avatar

Stargazers

Ganesh 1cloud 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.