Skip to content

Commit fe85bf5

Browse files
authored
Remove mentions of private apps (Shopify#1062)
* Remove mentions of private app * Restore invalid deletions * Fix wording Co-authored-by: Andy Waite <andyw8@users.noreply.github.com>
1 parent df9f599 commit fe85bf5

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ To follow these usage guides, you will need to:
2323

2424
- have a working knowledge of ruby and a web framework such as Rails or Sinatra
2525
- have a Shopify Partner account and development store
26-
- _OR_ have a test store where you can create a private app
2726
- have an app already set up in your test store or partner account
2827
- add the URL and the appropriate redirect for your OAuth callback route to your app settings
2928

@@ -55,8 +54,8 @@ ShopifyAPI::Context.setup(
5554
scope: "read_orders,read_products,etc",
5655
session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below
5756
is_embedded: true, # Set to true if you are building an embedded app
58-
is_private: false, # Set to true if you are building a private app
5957
api_version: "2022-01" # The version of the API you would like to use
58+
is_private: false, # Set to true if you have an existing private app
6059
)
6160
```
6261

@@ -68,7 +67,7 @@ Session information would is typically stored in cookies on the browser. However
6867

6968
### Performing OAuth
7069

71-
Next, unless you are making a private app, you need to go through OAuth as described [here](https://shopify.dev/apps/auth/oauth) to create sessions for shops using your app.
70+
You need to go through OAuth as described [here](https://shopify.dev/apps/auth/oauth) to create sessions for shops using your app.
7271
The Shopify API gem tries to make this easy by providing functions to begin and complete the OAuth process. See the [Oauth doc](docs/usage/oauth.md) for instructions on how to use these.
7372

7473
### Register Webhooks and a Webhook Handler

docs/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This page will outline everything you need to know and the steps you need to fol
55
## Requirements
66

77
- A working knowledge of ruby and a web framework such as Rails or Sinatra
8-
- A private or custom app already set up in your test store or partner account
8+
- A custom app already set up in your test store or partner account
99
- We recommend `ngrok` to tunnel traffic to your localhost for testing
1010

1111
## Installation

docs/usage/oauth.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
Once the library is set up for your project, you'll be able to use it to start adding functionality to your app. The first thing your app will need to do is to obtain an access token to the Admin API by performing the OAuth process.
44

55
To do this, you can follow the steps below.
6-
7-
**Note:** You do not need to go through the OAuth process if you are creating a private app. In this case you can simply set your `<key+password>` as the `api_secret_key` in `ShopifyAPI::Context.setup`. For more information on authenticating a Shopify app please see the [Types of Authentication](https://shopify.dev/apps/auth#types-of-authentication) page.
6+
For more information on authenticating a Shopify app please see the [Types of Authentication](https://shopify.dev/apps/auth#types-of-authentication) page.
87

98
## Add a route to start OAuth
109

@@ -53,7 +52,7 @@ def callback
5352
cookies: cookies.to_h,
5453
auth_query: ShopifyAPI::Auth::Oauth::AuthQuery.new(request.parameters.symbolize_keys.except(:controller, :action))
5554
)
56-
55+
5756
cookies[auth_result[:cookie].name] = {
5857
expires: auth_result[:cookie].expires,
5958
secure: true,
@@ -66,7 +65,7 @@ def callback
6665
head 307
6766
response.set_header("Location", "<some-redirect-url>")
6867
rescue => e
69-
puts(e.message)
68+
puts(e.message)
7069
head 500
7170
end
7271
end

0 commit comments

Comments
 (0)