Git Product home page Git Product logo

rentprep-sdk's Introduction

RentPrep API

RentPrep API for running background and other checks on applying renters.

This module lets you create and query applications; along with add and remove applicants.

Install

$ npm i -s git+https://[email protected]:Villa-Rentals/rentprep-sdk.git

Usage

Configure Strategy

The RentPrep API authenticates using the api key. This api key can be requested by contacting RentPrep directly. The library needs to be initialized with the api key and a flag determining production. Example:

new RentPrep({
  production: false,
  key: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
});

Making Requests

See the documentation for more information about the SDK.

Tests

The api key is required for the tests to pass. This can be obtained by contacting RentPrep directly. Once these key has been acquired, create a .env file from the .env.example file and provide the key. This will be used to authenticate your requests.

$ npm install --dev
$ npm test

License

The MIT License

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.