This example demonstrates a bare-bones Dotnet implementation of the OAuth flow for Square APIs. It serves a link that directs merchants to the OAuth Permissions form and handles the result of the authorization, which is sent to your application's Redirect URL (specified on the application dashboard).
This application requires the Dotnet Square SDK, which you install via dotnet. Open your terminal in this directory and type:
dotnet add package Square
-
Open the Developer Dashboard.
-
Choose Open on the card for an application.
-
At the top of the page, set the dashboard mode to the environment that you want to work with by choosing Sandbox or Production.
-
Choose OAuth in the left navigation pane. The OAuth page is shown.
-
In the Redirect URL box, enter the URL for the callback you will implement to complete the OAuth flow:
http://localhost:5218/square/callback
You can use HTTP for localhost but an actual web server implementation must use HTTPS.
-
In the Application ID box, copy the application ID.
-
In the Application Secret box, choose Show, and then copy the application secret.
-
Click Save.
-
In your project directory, create a copy of the
appsettings.example.json
file and name itappsettings.json
-
In the newly created
appsettings.json
file, replace theYOUR_SQUARE_APP_ID
andYOUR_SQUARE_APP_SECRET
placeholders with the Sandbox or Production application ID and application secret, respectively.Note that OAuth Sandbox credentials begin with a sandbox prefix and that the base URL for calling Sandbox endpoints is https://connect.squareupsandbox.com. When you implement for production, you need production credentials and use https://connect.squareup.com as the base URL.
WARNING: Never check your credentials/access_token into your version control system. We've added
appsettings.json
to the.gitignore
file to help prevent uploading confidential information.
-
Open the Developer Dashboard.
-
For testing in sandbox mode, in the Sandbox Test Accounts section, find one test acount and choose Open. For production mode, open the seller dashboard at https://squareup.com/dashboard/
-
Start the Dotnet server, if it is not running:
dotnet run
-
Open http://localhost:5218 to start.
Copyright 2024 Square, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Rate this sample app here!