Back4AppとStripeの統合ガイド: クラウド関数利用

cloud functionsを使用したstripe統合 はじめに このガイドでは、back4appのホストされたバックエンドをstripe apiと統合する方法を示します。back4appで構築するための最良のアーキテクチャの選択は、「 cloud functions 」と呼ばれる非常に強力な機能を使用することです。stripeとのクラウド関数の統合が完了すると、この統合をすべてのフロントエンドプロジェクト（web、ios、android）で使用できるようになります。このガイドでは、webの例を使用した完全なstripe統合を紹介します。 前提条件 このチュートリアルを完了するには、以下が必要です： back4appで作成されたアプリ。 新しいアプリを作成するチュートリアル を参照して、back4appでアプリを作成する方法を学んでください。 stripe にアカウントを作成してください。 目標 back4app cloud functionsを使用してwebプロジェクトにstripeを統合します。 stripeとは何ですか？ stripe は、25か国以上で運営されているテクノロジー企業で、個人と企業の両方がインターネット上で支払いを受け入れることを可能にします。stripeは、オンライン決済システムを運営するために必要な技術、詐欺防止、銀行インフラを提供することに重点を置いています。 このチュートリアルでは、関数を作成し、stripe apiをparse serverに統合する手順を説明します。 具体的には、このガイドでは、ユーザーがログインまたはサインアップし、クレジットカードを登録し、stripe paymentsを介してそれらを使用してサンプル購入を生成できる環境を作成します。また、サーバーとの接続とstripe apiが正常に動作しているかどうかをテストする方法についても説明します。 1 stripeアカウントを作成する stripeにアクセスし、 アカウントを作成する をクリックします。そこで、個人情報とアカウントが属する国を提供する必要があります。 次に、stripeアカウントを確認してください（stripeから確認リンクを含むメールが届きます）。そのリンクをクリックし、次にstripeのメールアドレスを確認する手順に従ってください。 2 データベースクラスの設定 ステップ1のためにstripe環境を設定した後、データベースを設定するためにback4appアプリのダッシュボードに移動します。このステップは必須ではありません。なぜなら、parseはクラウド関数が新しいオブジェクトを作成しようとする際に自動的にクラスを作成するからですが、どのフィールドが作成されるのか、なぜそれが必要なのかを説明するために進めていきます。 アプリのstripe関連データを保持する2つのクラスがあります paymentmethod paymentmethod と payment payment クラスのレイアウトは次のとおりです paymentmethod paymentmethod type type （文字列）：その値は常に「card」となります； card card （オブジェクト）：登録されたカードに関する完全なstripeデータを保持します； stripeid stripeid （文字列）：stripeバックエンドでこのpaymentmethodを参照するid； user user （parse userへのポインタ）：このpaymentmethodが属するuserへの直接参照。 payment payment data data （オブジェクト）：支払いに関する完全なstripeデータを保持します； user user （parse userへのポインタ）：このpaymentが属するuserへの直接参照。 私たちはまた、アプリのデフォルトの string string 値の列を2つ追加します user user クラスに setupsecret setupsecret と customerid customerid を追加します。これらは、 user user をそのstripeの対応物に関連付けるstripe idを含みます。 3 クラウドコードの実装 アプリで クラウドコード関数 https //docs parseplatform org/cloudcode/guide/#cloud functions を設定し、stripeモジュールをインストールしてコードをデプロイします。 クラウドコード環境をよりよく理解したい場合は、 このガイド を確認してください。 3 1 stripeキーを取得する 今、stripeダッシュボードを開き、上部の 開発者 開発者 ページに移動し、左メニューから apiキー apiキー を選択します。そのセクションで、あなたの 公開可能キー 公開可能キー とあなたの 秘密キー 秘密キー を見ることができます。 これらのキーを書き留めてください。後で必要になります。 3 2 クラウドコードファイル コンピュータ上に、モジュールをインストールし、cloud code関数をback4appに追加するための以下のファイルを作成してください。 1 { 2 "dependencies" { 3 "stripe" " " 4 } 5 } 以下のコードを新しいファイルに追加し、最上部にあなたのstripeシークレットキーを貼り付けるのを忘れないでください。 main js 1 const stripe secret key = 2 "your stripe secret key"; 3 const stripe = require("stripe")(stripe secret key); 4 5 // stripe needs an unique customer id to create payments, so after 6 // signing up, this function should be called to do this operation 7 parse cloud define("createstripecustomer", async (request) => { 8 // get parse user object 9 const userquery = new parse query(parse user); 10 userquery equalto("objectid", request params userid); 11 let user = await userquery first(); 12 13 const customer = await stripe customers create({ email user get("email") }); 14 // creates an stripe setupintent, that will enable the stripe lib to perform 15 // a singel operation related to payments 16 const intent = await stripe setupintents create({ 17 customer customer id, 18 }); 19 // set and save the stripe ids to the parse user object 20 user set({ 21 customerid customer id, 22 setupsecret intent client secret, 23 }); 24 return await user save(null, { usemasterkey true }); 25 }); 26 27 // creates new payment method for a registered customer 28 parse cloud define("addnewpaymentmethod", async (request) => { 29 // get parse user object 30 const userquery = new parse query(parse user); 31 userquery equalto("objectid", request params userid); 32 let user = await userquery first(); 33 34 // retrieve complete stripe payment method by its id 35 const stripepaymentmethod = await stripe paymentmethods retrieve( 36 request params paymentmethodid 37 ); 38 39 // create a new setupintent so the customer can add a new method next time 40 const intent = await stripe setupintents create({ 41 customer `${stripepaymentmethod customer}`, 42 }); 43 user set("setupsecret", intent client secret); 44 user = await user save(null, { usemasterkey true }); 45 46 // creates a new parse object in the paymentmethod class 47 let paymentmethod = new parse object("paymentmethod"); 48 paymentmethod set({ 49 user user, 50 type "card", 51 stripeid stripepaymentmethod id, 52 card stripepaymentmethod card, 53 }); 54 paymentmethod save(); 55 return true; 56 }); 57 58 // creates a new payment using a valid payment method 59 parse cloud define("createnewpayment", async (request) => { 60 // get parse user object 61 const userquery = new parse query(parse user); 62 userquery equalto("objectid", request params userid); 63 let user = await userquery first(); 64 65 const { amount, currency, payment method } = request params paymentdata; 66 67 // look up the stripe customer id 68 const customer = user get("customerid"); 69 70 // create a charge using an unique idempotency key 71 // to protect against double charges 72 const idempotencykey = new date() gettime(); 73 const payment = await stripe paymentintents create( 74 { 75 amount, 76 currency, 77 customer, 78 payment method, 79 off session false, 80 confirm true, 81 confirmation method "manual", 82 }, 83 { idempotencykey } 84 ); 85 // if the result is successful, write it back to the database 86 let payment = new parse object("payment"); 87 payment set({ 88 user user, 89 data payment, 90 }); 91 await payment save(); 92 93 return true; 94 }); 4 cloud codeに関数をアップロードする back4appのウェブサイトにアクセスし、ログインしてからアプリを見つけてください。その後、 ダッシュボード ダッシュボード リンクをクリックすると、以下のページに移動します。cloud codeをデプロイするには、 + 追加 + 追加 ボタンをクリックし、次に main js main js と package json package json のファイルを見つけてください。前のステップで作成したファイルです。その後、 デプロイ デプロイ ボタンをクリックします。 cloud code関数を設定しました。これを任意のプラットフォームで使用できます！ 関数のデプロイと呼び出し ガイドを確認して、関数の呼び出し方法を学んでください。次のステップでは、これらの関数を呼び出すjavascriptプロジェクトに取り組みます。 5 cloud codeとのjavascriptアプリの統合 ここでは、parseでユーザーのサインインまたはサインアップ、正当な支払い方法（クレジットカード）の作成、ユーザーに属するこれらの方法を使用して新しい支払いを作成するという3つの主要な機能を持つシンプルなhtmlページの例を示します。 新しいディレクトリをコンピュータに作成し、その中に以下のコードを含む新しいhtmlファイルを作成してください。 index html 1 2 3 4 5 6 7 back4app stripe payments 8 9 10 11 12 13 15 react on back4app 16 back4app stripe payments 17 18 19 20 21 22 sign in 23 24 25 26 sign in 27 28 don't have an account yet? sign up instead 29 30 31 sign up 32 33 34 35 sign up 36 37 already have an account? sign in instead 38 39 40 41 42 43 44 45 add new payment method 46 47 use any of the 48 stripe test cards 49 for this demo! 50 51 52 53 54 55 56 save card 57 58 59 60 create new payment 61 62 63 card (payment method) 64 65 66 68 69 currency 70 usd 71 brl 72 eur 73 74 75 charge selected card 76 77 78 79 payments 80 81 82 83 sign out 84 85 86 87 88 89 90 91 92 このファイルには2つの主要なセクションがあります。最初のセクションは認証セクションで、ユーザーがまだログインしていない場合はデフォルトで表示されます。ログイン後は、支払いセクションが表示され、stripe上でデータを作成するためのすべてのフォームと、back4appのcloud code関数と通信するためのフォームが含まれています。 私たちは今、すべてを結びつけるコードを含むjavascript関数を作成する必要があります。それは index js index js index js 1 // define and initialize parse and stripe libs 2 const parse app id = "your parse id"; 3 const parse js key = "your parse js key"; 4 parse initialize(parse app id, parse js key); 5 parse serverurl = "https //parseapi back4app com/"; 6 7 const stripe publishable key = "your stripe publishable key"; 8 const stripe = stripe(stripe publishable key); 9 10 // holds the currentuser complete parse object 11 let currentuser = null; 12 const setcompletecurrentuser = async () => { 13 // called when user is already signed in, completing 14 // the currentuser object with the full one 15 currentuser = await new parse query(parse user) 16 equalto("objectid", parse user current() id) 17 first(); 18 // retrieve and render user cards and payments 19 retrievecurrentuserpaymentmethods(); 20 retrievecurrentuserpayments(); 21 }; 22 23 const retrievecurrentuserpaymentmethods = async () => { 24 // query and render user paymentmethods 25 const pmquery = new parse query("paymentmethod"); 26 pmquery equalto("user", parse user current()); 27 paymentmethods = await pmquery find(); 28 renderpaymentmethodoptions(paymentmethods); 29 }; 30 31 const retrievecurrentuserpayments = async () => { 32 // query and render user payments 33 const paymentsquery = new parse query("payment"); 34 paymentsquery equalto("user", parse user current()); 35 payments = await paymentsquery find(); 36 renderpayments(payments); 37 }; 38 39 const renderpaymentmethodoptions = async (paymentmethods) => { 40 for (let paymentmethod of paymentmethods) { 41 const optionid = `card ${paymentmethod get("stripeid")}`; 42 let optionelement = document getelementbyid(optionid); 43 44 // add a new option if one doesn't exist yet 45 if (!optionelement) { 46 optionelement = document createelement("option"); 47 optionelement id = optionid; 48 document 49 queryselector("select\[name=payment method]") 50 appendchild(optionelement); 51 } 52 53 optionelement value = paymentmethod get("stripeid"); 54 optionelement text = `${paymentmethod get("card") brand} •••• ${ 55 paymentmethod get("card") last4 56 } | expires ${paymentmethod get("card") exp month}/${ 57 paymentmethod get("card") exp year 58 }`; 59 } 60 }; 61 62 const renderpayments = (payments) => { 63 for (let payment of payments) { 64 let lielement = document getelementbyid(`payment ${payment id}`); 65 if (!lielement) { 66 lielement = document createelement("li"); 67 lielement id = `payment ${payment id}`; 68 } 69 70 const paymentdata = payment get("data"); 71 let content = ""; 72 if ( 73 paymentdata status === "new" || 74 paymentdata status === "requires confirmation" 75 ) { 76 content = `creating payment for ${formatamount( 77 paymentdata amount, 78 paymentdata currency 79 )}`; 80 } else if (paymentdata status === "succeeded") { 81 const card = paymentdata charges data\[0] payment method details card; 82 content = `payment for ${formatamount( 83 paymentdata amount, 84 paymentdata currency 85 )} on ${card brand} card •••• ${card last4} ${paymentdata status}!`; 86 } else { 87 content = `payment for ${formatamount( 88 paymentdata amount, 89 paymentdata currency 90 )} ${paymentdata status}`; 91 } 92 lielement innertext = content; 93 document queryselector("#payments list") appendchild(lielement); 94 } 95 }; 96 97 // checks if user is already signed in on parse 98 if (parse user current() !== null) { 99 setcompletecurrentuser(); 100 // hide auth screen and show payment fields 101 document getelementbyid("auth") style display = "none"; 102 document getelementbyid("content") style display = "block"; 103 } 104 105 // toggle signin and signup forms 106 document 107 queryselector("#signup toggle") 108 addeventlistener("click", async ( event) => { 109 document getelementbyid("auth signin form") style display = "none"; 110 document getelementbyid("auth signup form") style display = "block"; 111 clearauthformfields(); 112 }); 113 document 114 queryselector("#signin toggle") 115 addeventlistener("click", async ( event) => { 116 document getelementbyid("auth signup form") style display = "none"; 117 document getelementbyid("auth signin form") style display = "block"; 118 clearauthformfields(); 119 }); 120 121 // clear auth form fields 122 const clearauthformfields = () => { 123 document 124 queryselector("#auth") 125 queryselectorall("input") 126 foreach((input) => (input value = "")); 127 }; 128 129 // handle auth forms 130 document 131 queryselector("#auth signin form") 132 addeventlistener("submit", async (event) => { 133 event preventdefault(); 134 toggleallbuttonsenabled(false); 135 const form = new formdata(event target); 136 const email = form get("email"); 137 const password = form get("password"); 138 139 // try to signin on parse 140 try { 141 let user = await parse user login(email, password); 142 if (user !== null) { 143 currentuser = user; 144 // hide auth screen and show payment fields 145 document getelementbyid("auth") style display = "none"; 146 document getelementbyid("content") style display = "block"; 147 clearauthformfields(); 148 } 149 } catch (error) { 150 alert(error); 151 } 152 toggleallbuttonsenabled(true); 153 }); 154 155 document 156 queryselector("#auth signup form") 157 addeventlistener("submit", async (event) => { 158 event preventdefault(); 159 toggleallbuttonsenabled(false); 160 const form = new formdata(event target); 161 const email = form get("email"); 162 const password = form get("password"); 163 164 // try to signup on parse 165 try { 166 let user = await parse user signup(email, password, { email email }); 167 // cloud code to create stripe user and intent 168 user = await parse cloud run("createstripecustomer", { userid user id }); 169 if (user !== null) { 170 currentuser = user; 171 // hide auth screen and show payment fields 172 document getelementbyid("auth") style display = "none"; 173 document getelementbyid("content") style display = "block"; 174 clearauthformfields(); 175 } 176 } catch (error) { 177 alert(error); 178 } 179 toggleallbuttonsenabled(true); 180 }); 181 182 // signout from parse 183 document queryselector("#signout") addeventlistener("click", async ( event) => { 184 await parse user logout(); 185 currentuser = null; 186 // show auth screen and hide payment fields 187 document getelementbyid("auth") style display = "block"; 188 document getelementbyid("content") style display = "none"; 189 }); 190 191 // creates stripe card ui element 192 const elements = stripe elements(); 193 const cardelement = elements create("card"); 194 cardelement mount("#card element"); 195 196 // handle add new card form 197 document 198 queryselector("#payment method form") 199 addeventlistener("submit", async (event) => { 200 event preventdefault(); 201 toggleallbuttonsenabled(false); 202 if (!event target reportvalidity()) { 203 return; 204 } 205 const form = new formdata(event target); 206 const cardholdername = form get("name"); 207 208 const result = await stripe confirmcardsetup( 209 currentuser get("setupsecret"), 210 { 211 payment method { 212 card cardelement, 213 billing details { 214 name cardholdername, 215 }, 216 }, 217 } 218 ); 219 220 if (result error) { 221 alert(result error message); 222 toggleallbuttonsenabled(true); 223 return null; 224 } 225 226 let setupintent = result setupintent; 227 228 // cloud code to add new payment method 229 let cloudcoderesult = await parse cloud run("addnewpaymentmethod", { 230 userid currentuser id, 231 paymentmethodid setupintent payment method, 232 }); 233 234 toggleallbuttonsenabled(true); 235 alert("success on creating a new payment method!"); 236 237 // update payment method options 238 retrievecurrentuserpaymentmethods(); 239 }); 240 241 // handles new payment form 242 document 243 queryselector("#payment form") 244 addeventlistener("submit", async (event) => { 245 event preventdefault(); 246 toggleallbuttonsenabled(false); 247 const form = new formdata(event target); 248 const amount = number(form get("amount")); 249 const currency = form get("currency"); 250 // gets selected card option id 251 const paymentmethod = form get("payment method"); 252 const paymentdata = { 253 payment method paymentmethod, 254 currency, 255 amount formatamountforstripe(amount, currency), 256 status "new", 257 }; 258 // cloud code to create new payment 259 let cloudcoderesult = await parse cloud run("createnewpayment", { 260 userid currentuser id, 261 paymentdata paymentdata, 262 }); 263 264 toggleallbuttonsenabled(true); 265 alert("success on creating a new payment!"); 266 267 retrievecurrentuserpayments(); 268 }); 269 270 // helper functions 271 const toggleallbuttonsenabled = (enabledvalue) => { 272 document 273 queryselectorall("button") 274 foreach((button) => (button disabled = !enabledvalue)); 275 }; 276 277 const formatamount = (amount, currency) => { 278 amount = zerodecimalcurrency(amount, currency) 279 ? amount 280 (amount / 100) tofixed(2); 281 return new intl numberformat("en us", { 282 style "currency", 283 currency, 284 }) format(amount); 285 }; 286 287 // format amount for stripe 288 const formatamountforstripe = (amount, currency) => { 289 return zerodecimalcurrency(amount, currency) 290 ? amount 291 math round(amount 100); 292 }; 293 294 // check if we have a zero decimal currency 295 // https //stripe com/docs/currencies#zero decimal 296 const zerodecimalcurrency = (amount, currency) => { 297 let numberformat = new intl numberformat(\["en us"], { 298 style "currency", 299 currency currency, 300 currencydisplay "symbol", 301 }); 302 const parts = numberformat formattoparts(amount); 303 let zerodecimalcurrency = true; 304 for (let part of parts) { 305 if (part type === "decimal") { 306 zerodecimalcurrency = false; 307 } 308 } 309 return zerodecimalcurrency; 310 }; ファイルの先頭にstripeの公開可能キーとparseアプリidおよびjsキーを追加することを確認してください。これらはこのスクリプトで確認し理解するための重要な要素のいくつかです スクリプトを初めて読み込む際に、ページの正しい部分をレンダリングするために parse user current parse user current メソッドの使用を確認してください; parseでのアクションを実行するフォーム送信アクションリスナー、例えばサインインやサインアップ、stripe関連のオブジェクトを作成し、back4appデータベースに保存するためのcloud code関数を呼び出すこと; 現在のユーザーの payment payment と paymentmethod paymentmethod オブジェクトを取得するためにparseでクエリを行う “retrieve” および “return” メソッド。 アプリをテストする前に、同じディレクトリ内に app css app css という名前のcssファイルに次のスタイルシートを追加してください 1 / back4app guide / 2 3 , 4 before, 5 after { 6 margin 0; 7 padding 0; 8 box sizing inherit; 9 } 10 11 html { 12 font family sans serif; 13 box sizing border box; 14 outline none; 15 overflow auto; 16 } 17 18 body { 19 margin 0; 20 background color #fff; 21 } 22 23 h1, 24 h2, 25 h3, 26 h4, 27 h5, 28 h6 { 29 margin 0; 30 } 31 32 p { 33 margin 0; 34 } 35 36 container { 37 width 100%; 38 max width 600px; 39 margin auto; 40 padding 20px 0; 41 } 42 43 wrapper { 44 width '90%'; 45 align self 'center'; 46 } 47 48 header { 49 display flex; 50 flex direction column; 51 align items center; 52 padding 25px 0; 53 background color #208aec; 54 } 55 56 header logo { 57 height 55px; 58 margin bottom 20px; 59 object fit contain; 60 } 61 62 header text bold { 63 margin bottom 3px; 64 color rgba(255, 255, 255, 0 9); 65 font size 16px; 66 font weight bold; 67 } 68 69 header text { 70 color rgba(255, 255, 255, 0 9); 71 font size 15px; 72 } 73 74 flex row { 75 display flex; 76 } 77 78 flex between { 79 display flex; 80 align items center; 81 justify content space between; 82 } 83 84 form wrapper { 85 margin top 20px; 86 margin bottom 10px; 87 } 88 89 form heading { 90 margin bottom 10px; 91 } 92 93 form { 94 padding bottom 25px; 95 margin 25px 0; 96 border bottom 1px solid rgba(0, 0, 0, 0 12); 97 } 98 99 form input { 100 display block; 101 width 100%; 102 height 46px; 103 padding 0 15px; 104 background color #e6e6e6; 105 border 1px solid #ccc; 106 border radius 999px; 107 margin bottom 20px; 108 font size 16px; 109 } 110 111 form button { 112 display block; 113 width 100%; 114 height 42px; 115 padding 0 15px; 116 background color #208aec; 117 border 1px solid #208aec; 118 border radius 999px; 119 color #fff; 120 font size 16px; 121 cursor pointer; 122 } 123 124 form hint { 125 display block; 126 margin top 20px; 127 color rgba(0, 0, 0, 0 5); 128 font size 16px; 129 text align center; 130 text decoration color rgba(0, 0, 0, 0 4); 131 } 132 133 card element wrapper { 134 padding 13px 15px; 135 margin bottom 20px; 136 background color #e6e6e6; 137 border 1px solid #ccc; 138 border radius 999px; 139 } アプリをテストするには、次のようなローカルhttpサーバーを使用してください。 http serverノードパッケージ サインアップ後、あなたのアプリは次のようになります 結論 上記のガイドに従って、back4appのcloud code関数を使用してstripeを利用し、シンプルなjavascriptアプリに支払いを統合することができました! stripeの統合中に問題が発生した場合や、関数が機能しない場合は、チャットを通じて私たちのチームにご連絡ください!