Git Product home page Git Product logo

alpaca-gcp-proxy's Introduction

pdm-managed Sourcery

alpaca-gcp-proxy

GCP Function to securely proxy API calls to Alpaca Broker API, including Plaid and Stytch.

The repo is intended to simplify development of mobile / web apps on top Alpaca.

Proxies

Alpaca

All calls abbreviated by /alpaca will be forwarded to Alpaca, using the predefined Alpaca.Markets Broker API base URL.

Plaid

All calls abbreviated by /plaid will be forwarded to Plaid.

Stytch

All calls abbreviated by /stytch will be forwarded to Stych.

General

The proxy function can log requests & responses (based on the DEBUG environment variable)

The function uses security best practices to ensure compliance and security of Alpaca credentials.

Deployment

The project is deployed using GCP Cloud Build. The deployment will create a proxy end-point. It is suggested to set up a deployment trigger in CloudBuild.

Secrets

Alpaca

Add two secrets to GCP Secrets Manager:

  • alpaca_api_key
  • alpaca_api_secret

Obtained after registering to Alpaca Broker API

Plaid

  • plaid_client_id
  • plaid_secret

Obtained after registering to Plaid

Stytch

  • stytch_projet_id
  • stytch_secret

Obtained after registering to Stytch

General

Once deployed, the GCP Function service account needs to be added to the Secrets with role Secret Accessor

Environment Variables

  • PROJECT_ID: GCP project-id hosting GCP Function and secret
  • ALPACA_BASE_URL: Alpaca base URL defaults to sandbox
  • PLAID_BASE_URL: Plaid base URL default to sandbox
  • STYTCH_BASE_URL: Stytch base URL default to test
  • DEBUG: "True"/"False" (default "True") log both request and response

alpaca-gcp-proxy's People

Contributors

amor71 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  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.