Setup

We currently have no publicly accessible Ruby SDK library, so it may be beneficial for you to use one of the various GraphQL clients as provided through the link below, or to setup your own.

GraphQL Code Libraries, Tools and Servicesgraphql

For our examples in Ruby, we're going to be using a very simple custom client to make our calls to the Kana GraphQL API - specify the following as its own class:

# Install the following gems beforehand and require them
require 'httparty'
require 'json'

# Setup the GraphQL API client in Ruby
class KanaGraphqlClient
  def initialize(api_key)
    @api_key = api_key
  end

  def execute(query:, variables: nil)
    HTTParty.post(
      "https://api.usekana.com/graphql",
      headers: {
        'Content-Type'  => 'application/json',
        'Authorization' => @api_key
      },
      body: {
        query: query,
        variables: variables
      }.to_json
    )
  end
end

We can now initialize this when required by providing a Kana API Key - we'll tie this initialized object to the client variable like so:

client = KanaGraphqlClient.new(#{API_KEY})

Make sure to either replace #{APIKEY} or define API_KEY with the Kana API Key you were provisioned. More on authentication can be found here.

You're now ready to go!