Square Ruby SDK Quickstart
Learn how to quickly set up and test the Square Ruby SDK.
Before you begin, you need a Square account and account credentials. You use the Square Sandbox for the Quickstart exercise.
Create a Square account and an application. For instructions, see Create an account and application.
Get a Sandbox access token from the Developer Dashboard. For instructions, see Step 2.1: Make a test API call and review your account.
Install the following:
Ruby. Square supports Ruby version 2.7 or later.
Square Ruby SDK. To install it, use the
Open a new terminal window.
Create a new directory for your project, and then go to that directory.
In your project directory, create a new file named quickstart.rb with the following content:
require 'square' client = Square::Client.new( access_token: ENV.fetch('SQUARE_ACCESS_TOKEN'), environment: 'sandbox', timeout: 1 ) result = client.locations.list_locations if result.success? result.data.locations.each do |location| printf("%s: %s, %s, %s\n", location[:id], location[:name], location[:address][:address_line_1], location[:address][:locality]) end elsif result.error? result.errors.each do |error| warn error[:category] warn error[:code] warn error[:detail] end end
Save the quickstart.rb file.
This code does the following:
The Ruby code in this Quickstart reads your Square Sandbox access token from the
SQUARE_ACCESS_TOKEN environment variable. This helps avoid the use of hardcoded credentials in the code.
For the following commands, replace
yourSandboxAccessToken with your Square Sandbox access token:
Run the following command:
Verify the result. You should see at least one location (Square creates one location when you create a Square account).