Code Monkey home page Code Monkey logo

exp20-api-best-practices's Introduction

Experience 2020 - API Best Practices

This repo provides the sample postman collection demonstrated during the API Best Practices session at the Ellie Mae Virtual Experience 2020.

Prerequisites: Postman software installation Developer Connect client id / secret Encompass credentials

Setup

  1. Import Experience 2020 - API Best Practices.postman_collection.json l. Import Experience.postman_environment.json
  2. Populate the Postman Environment with your developer connect client id / secret / Encompass credentials

Running the Postman Collection

Authentication

In order to test the API user postman, reach out to your Account Manager to request an API User key. Once this has been done, enter in the information to the api_user_client_id and api_user_client_secret environment variables.

Lock and Concurrency

  1. Add the Encompass credentials for two Encompass users to the smart_client_user, smart_client_user2, smart_client_password, smart_client_password2 environment variables
  2. Find a test loan or create a new loan and retrieve the loan guid of the loan to enter into the loan_guid environment variable
  3. Run the "00 - Get Security Token user1" and "00 - Get Security Token user2" requests to generate the access tokens for the two users
  4. You can now run each request in the Lock and Concurrency subfolders

Webhooks

To test the webhooks collection, you will need to specify an endpoint for the webhook events to post to in the "Create Subscription" body. There are a few third party services that provide a way to view the webhook payload without having to host a publicly accessible endpoint that you could use to test out the webhook (e.g. webhook.site / requestbin.com)

exp20-api-best-practices's People

Watchers

James Cloos avatar Anthony avatar tingtingting avatar  avatar

Forkers

marcllahona

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.