Skip to content
This repository has been archived by the owner on Jun 15, 2022. It is now read-only.

Latest commit

 

History

History
308 lines (205 loc) · 9.18 KB

README.md

File metadata and controls

308 lines (205 loc) · 9.18 KB
Raw

Vipps for Streamlabs

Twitch screenshot

This is a quick hack from an internal Vipps hackathon. No guarantees whatsoever! We're always happy to help, but please not that this is not an officially supported Vipps solution, and we have to prioritize customers using official products. Still:Issues and PRs are welcome!

This hack is an integration between Vipps and Streamlabs.

Read about why we made this "hack" in this article on Medium

This is a Spring Boot Java application and React Express.js which integrates with the Vipps eCom v2 API and Streamlabs API.

This was useful for us:

How to run this yourself on Heroku

Prerequisites

  • Vipps På Nett, which requires a company with a Norwegian organisation number. Enkeltpersonforetak is sufficient.
  • Accesstoken for your Streamlabs account (not necessary to test the flow. if you don't have it now fill in a gibberish string when asked to)

Setup Heroku

  1. Install Heroku CLI from https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up

  2. Login to Heroku

heroku login

Deploy code to Heroku

  1. Clone Server repository
git clone <repo>
  1. Cd into repo
cd /vipps-streamlabs
  1. Replace the image and name of streamer in application with your own

Replace stream-profile-picture.png in the /frontend/public/img directory with your own. Height and width should be equal for best appearance.

Change text on line 143 in document frontend/src/client/home.jsx to reflect correct streamer name.

  1. Cd into backend folder and init git
~/vipps-streamlabs$ cd ../backend
~/backend$ git init
  1. Create Heroku App for server. You need to keep the URL for the herokuapp for further steps
~/backend$ heroku create

This will return a URL for the created app back. We need this to configure our Server.

Creating <app-name>... done, stack is heroku-18
<heroku-app-url> | <heroku-git-url>
Git remote heroku added
  1. Create a Heroko Postgres addon
~/backend$ heroku addons:create heroku-postgresql:hobby-dev
  1. Cd into frontend folder and init git
~/backend$ cd ../frontend
~/frontend$ git init
  1. Create Heroku App for the frontend. You need to keep the URL for the herokuapp for further steps
~/frontend$ heroku create

This will return a URL for the created app back. We need this in later steps.

Creating <app-name>... done, stack is heroku-18
<heroku-app-url> | <heroku-git-url>
Git remote heroku added
  1. Set environment variables in application.yaml, which is located in /backend/src/main/resources.

The TRANSACTION_TEXT is what that will be shown to user when approving payment in Vipps.

STREAMLABS_ACCESS_TOKEN: Streamlabs access token
STREAMLABS_CLIENT_ID: 123
STREAMLABS_CLIENT_SECRET: 123x<t>
VIPPS_CALLBACK_PREFIX: <heroku-app-url>
VIPPS_CLIENT_ID: <Client-ID>
VIPPS_CLIENT_SECRET: <Client-Secret>
VIPPS_FALLBACK_URL: <heroku-app-url>/fallback
VIPPS_MERCHANT_SERIAL_NUMBER: <MSN>
VIPPS_OCP_APIM_SUBSCRIPTION_KEY_ACCESSTOKEN: <Sub-key>
VIPPS_OCP_APIM_SUBSCRIPTION_KEY_ECOMMERCE: <Sub-key>
TRANSACTION_TEXT: "Donasjon til Streamer"
STREAMER_NAME: "Streamer"
  1. Set SERVER_URL in frontend directory

In /frontend/src/server/routes/paymentApi.js in line 5, change variable SERVER_URL to the URL for backend app.

  1. Deploy both apps to Heroku

Deploy Server:

~/backend$ git add .
~/backend$ git commit -m "initial commit"
~/backend$ git push heroku master

Cd into frontend

~/backend$ cd ../frontend

Deploy frontend

~/frontend$ git add .
~/frontend$ git commit -m "initial commit"
~/frontend$ git push heroku master

Test your application

When both apps is deployed successfully, go to the frontend URL. From there you will be able to do donations.

Add init donate button to streamers channel description on Twitch

In order to let people use your application and hopefully donate, you'll need to share link to the frontend application to them. You can share a link in cleartext or choose to place a button somewhere that will take the user to your application. For example in the streamer's description on Twitch.

Vipps donate button

Donate button

Screenshot from Twitch

Upload image to Twitch

  • Upload the image that should be visible in the Twitch description to initiate Vipps donation
  • Change "Bilde lenker til" to your hostname or IP address.

Technical documentation

Vipps API

Please note: This is NOT made to be a reference implementation.

We make the code available here, in case it may be useful for others. Issues and PRs are welcome!

Streamlabs API

  • If a callback from Vipps API was successful, it triggered a POST request to the Streamlabs POST:/donations endpoint. The streamer then has to configure in the admin panel how the donation will be shown in the stream.

Flow

Actors used below

  • Vipps = Vipps API
  • Streamlabs = Streamlabs API
  • Server = Spring Boot App
  • Frontend = React Express.js App
  • Streamer = Human streaming on Twitch
  • User = Human watching Streamer

Twitch screenshot

This is the normal view of a stream on Twitch.

Donate button in streamers channel description

Twitch screenshot

The Vipps donate button is shown. Streamers are free to include whatever in their channel/stream description.

  1. User is watching a streamer on Twitch
  2. User click "Donér med Vipps"-button

Frontend Landing page

Twitch screenshot

Clicking the Vipps button sends the user to this page.

  1. User is redirected to frontend and is showed a form
  2. User fills in name, message to streamer and amount
  3. Frontend sends form data to server. Amount in USD is converted to NOK before sent to Vipps.
  4. Server saves the donation in a DB and initiate payment with Vipps that responds with URL that user need to approve in Vipps app

Vipps landing page

Twitch screenshot

The standard Vipps landing page, where the user enters his/her phone number and confirms the donation.

  1. If user is on mobile, user is redirected to Vipps app to approve. If desktop, user will be redirected to a Vipps landing page first to approve it's phone number which will trigger a push notification on users phone.

Payment request in the Vipps app

Vipps screenshot

The payment request in the Vipps app.

  1. User approve or decline payment in the Vipps app
  2. Vipps sends callback to server with order status (FAILED, SUCCESS, CANCELLED)
  3. Server then update the donation in the DB.
  4. If order status is SUCCESS server notify Streamlabs with a POST request

Payment confirmation in the Vipps app

Vipps screenshot

The green "Betalt" bubble shows that the payment was successful.

Success

Twitch screenshot

Confirmation of the successful Vipps donation.

  1. User is redirected to /fallback/{orderId} in frontend
  2. Frontend then asks server what the status is for the donation. If server haven't recieved any callback from Vipps, it does a /getPaymentDetails request to Vipps before replying to the frontend.
  3. fallback page on frontend is rendered Based on FAILED, SUCCESS or CANCELLED in server response

Donation shown on stream

Twitch screenshot

Donation shown on the stream. Our backend received successful callback which trigger "/donations" POST-request to Streamlabs.

Questions?

We're always happy to help, but please not that this is not an officially supported Vipps solution. Issues and PRs are welcome!