Skip to content

Latest commit

 

History

History
106 lines (87 loc) · 4.11 KB

custom_apps.md

File metadata and controls

106 lines (87 loc) · 4.11 KB
Raw

Custom Apps

If you have followed instructions on creating custom apps, you should be able to access your API token without having to go through the OAuth flow.

You can follow instructions for initializing the session object to construct the session object to be used in authenticated API calls to your store. There are 2 methods to use the session object to make API calls:

  1. Passing session object into each client request
  2. Setting active_session in ShopifyAPI::Context

Initializing the Session object

Following is a basic example to construct a simple Session object. You can see full list of parameters for this object in the class definition

session = ShopifyAPI::Auth::Session.new(
  shop: "#{your_shop_name}.myshopify.com",
  access_token: "the_token_for_your_custom_app_found_in_admin"
)

Using Session to make API calls

Passing session object into each client request

Example:

def make_api_request(shop)
  # 1. create session object
    session = ShopifyAPI::Auth::Session.new(
      shop: "#{your_shop_name}.myshopify.com",
      access_token: "the_token_for_your_custom_app_found_in_admin"
    )

  # 2a. Create API client with the session information
  # session must be type `ShopifyAPI::Auth::Session`
  graphql_client = ShopifyAPI::Clients::Graphql::Admin.new(session: session)
  response = graphql_client.query(query: MY_API_QUERY)

  # 2b. REST example
  product_count = ShopifyAPI::Product.count(session: session)

  ...
end

Setting active_session in ShopifyAPI::Context

Alternatively, if you don't want to keep having to create/retrieve a Session object for a shop, you may set ShopifyAPI::Context.active_session. All of the API client classes will use the active_session if the session passed in is nil.

Example:

#### Configuration
def configure_app
  # This method is called before making authenticated API calls
  session = ShopifyAPI::Auth::Session.new(
      shop: "#{your_shop_name}.myshopify.com",
      access_token: "the_token_for_your_custom_app_found_in_admin"
    )

  ShopifyAPI::Context.setup(
    api_key: "<api-key>",
    api_secret_key: "<api-secret-key>",
    scope: "read_orders,read_products,etc",
    is_embedded: true, # Set to true if you are building an embedded app
    api_version: "2024-01", # The version of the API you would like to use
    is_private: true, # Set to true if you have an existing private app
  )

  # Activate session to be used in all API calls
  # session must be type `ShopifyAPI::Auth::Session`
  ShopifyAPI::Context.activate_session(session)
end

#### Using clients to make authenticated API calls
def make_api_request
  # 1. Create API client without session information
  # The graphql_client will use `ShopifyAPI::Context.active_session` when making API calls
  # you can set the api version for your GraphQL client to override the api version in ShopifyAPI::Context
  graphql_client = ShopifyAPI::Clients::Graphql::Admin.new(api_version: "2024-07")

  # 2. Use API client to make queries
  # Graphql
  query = <<~QUERY
    {
      products(first: 10) {
        edges {
          cursor
          node {
            id
            title
            onlineStoreUrl
          }
        }
      }
    }
  QUERY

  response = graphql_client.query(query: query)

  # Use REST resources to make authenticated API call
  product_count = ShopifyAPI::Product.count
  
  ...
end

⚠️ See following docs on how to use the API clients: