Git Product home page Git Product logo

integration-bruno's Introduction

Ethos Integration Bruno Examples

Bruno is a Fast and Git-Friendly Opensource API client, aimed at revolutionizing the status quo represented by Postman, Insomnia and similar tools out there. It stores your collections directly in a folder on your filesystem and it uses a plain text markup language, Bru, to save information about API requests.

This repository contains a Bruno collection and environment. A collection is simply a group of related API requests. The collection here contains examples of how to do things in Ethos Integration like obtaining an access token, calling GET/POST/PUT/DEL on a resource and consuming change-requests. An environment is a set of key-value pairs, essentially variables, that can be shared among API requests. The environment in this repository is used to store an API key and JWT access token.

For more Bruno learning and documentation start here https://www.usebruno.com

Getting Started

To begin, download or clone this repository onto your local machine. The required collection and environment files are provided in .bru format. Open the Bru application and import the collection by clicking the "Open Collection" button located in the center of the interface.

Within the Finder application, locate the directory containing your cloned repository. Subsequently, select the desired collection for import.

Upon successful import of the collection, navigate to the three dots "..." and click it to access the Settings menu. Within Settings, configure the environment and collection pre-script information as needed.

On the configuration popup, provide the right Ethos API Key and then hit Save

After configuring the environment variables, choose Ethos Integration as your environment. Now, you are now ready to initiate API execution.

Pre-request Script

This collection contains a pre-request script to simplify calling ethos end points. The script will automatically:

  • Prepend the ethos integration url to any request that needs it. For example, to call https://integrate.elluciancloud.com/persons end point - you only need to enter 'persons'. Any endpoint that does not have the /api/{resource} pattern you will need to enter the full url.
  • Manage Authorization token. The script will get, store and use the authorization token. This requires a valid value in the variable ethosApiKey
  • Encode query string parameters

integration-bruno's People

Contributors

saravanan-ellucian avatar

Stargazers

Lucas Lower avatar Blake Smith avatar  avatar Tony Bateman avatar Kevin Saylor, Jr. avatar

Watchers

Robert Levy avatar Sarav avatar Bret Hansen avatar  avatar

Forkers

tilottamwagh

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.