# Ruby SDK

> Crowdin Ruby API client / SDK

URL: https://store.crowdin.com/crowdin-api-client-ruby
Category: Development
Type: Guide
Author: Crowdin

The Crowdin Ruby client is a lightweight interface to the Crowdin API v2. It provides common services for making API requests.

Crowdin API is a full-featured RESTful API that helps you to integrate localization into your development process. The endpoints that we use allow you to easily make calls to retrieve information and to execute actions needed.

[<img src='https://img.shields.io/gem/v/crowdin-api?logo=ruby&cacheSeconds=1800' class='blank'/>](https://rubygems.org/gems/crowdin-api)
[<img src='https://img.shields.io/gem/dt/crowdin-api?cacheSeconds=1800' class='blank'/>](https://rubygems.org/gems/crowdin-api)
[<img src='https://img.shields.io/gem/dtv/crowdin-api?cacheSeconds=1800' class='blank'/>](https://rubygems.org/gems/crowdin-api)
[<img src='https://codecov.io/gh/crowdin/crowdin-api-client-ruby/branch/main/graph/badge.svg?token=OJsyJwQbFM' class='blank'/>](https://codecov.io/gh/crowdin/crowdin-api-client-ruby)
[<img src='https://img.shields.io/github/license/crowdin/crowdin-api-client-ruby?cacheSeconds=1800' class='blank'/>](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/LICENSE)

For more about Crowdin API see the documentation:

- [Crowdin](https://developer.crowdin.com/api/v2/)
- [Crowdin Enterprise](https://developer.crowdin.com/enterprise/api/v2/)

## Installation

Add this line to your application's Gemfile:

```gemfile
gem 'crowdin-api', '~> 1.2.1'
```

And then execute:

```console
bundle install
```

Or install it yourself as:

```console
gem install crowdin-api
```

### Requirements

* Ruby >= 2.4

## Seeking Assistance and Contributing

If you find any problems or would like to suggest a feature, please read the [How can I contribute](https://github.com/crowdin/crowdin-api-client-ruby/blob/main/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.