Lokalise APIv2 Ruby SDK

Ruby interface for the Lokalise APIv2 that represents returned data as Ruby objects.

View the Project on GitHub lokalise/ruby-lokalise-api

OAuth 2

Setting up the client

Lokalise also provides OAuth 2 authentication flow. Let’s see how to generate an OAuth 2 token. The obtained token can be used to perform API requests on behalf of a user.

Please note that you can also take advantage of the omniauth-lokalise gem which makes the process even simpler. Still, you’ll need Lokalise Ruby SDK to refresh your tokens.

First of all, you’ll need to create an auth client:

auth_client = RubyLokaliseApi.auth_client 'OAUTH2_CLIENT_ID', 'OAUTH2_CLIENT_SECRET'

Pass your client ID and client secret.

Generating auth URL

Next, generate an authentication URL:

url = auth_client.auth scope: 'read_projects',
                       redirect_uri: 'http://example.com/callback',
                       state: 'random string'

The auth method returns a URL looking like this:


Your customers have to visit this URL and allow access to proceed. After allowing access, the customer will be presented with a secret code that has to be used in the following step.

Generating OAuth 2 token

Next, call the #token method and pass a secret code obtained on the previous step:

response = auth_client.token 'secret code'

The response will contain a hash with the following keys:

Refreshing OAuth 2 token

Once your access token expires, you can refresh it in the following way:

response = auth_client.refresh 'YOUR_REFRESH_TOKEN'

The response will contain a hash with the following keys:

Using OAuth 2 token

If you’re using an API token obtained via OAuth 2, you must initialize the client in a slightly different way:

require 'ruby_lokalise_api'

@client = RubyLokaliseApi.oauth2_client 'YOUR_OAUTH2_ACCESS_TOKEN'

This is because with OAuth2 tokens, a different authorization header must be sent.

Now you can send requests on the user’s behalf!