Fnsapi

Gem implements API with Federal Tax services of Russia.

Гем реализуют взаимодействие с официальным апи проверки чеков Федеральной Налоговая службы России. Чтобы получить токен неоходимо подать заявку на сайте ФНС. Документация для получения токена.

Недокументированное апи для работы с данными чеков ФНС (при большом колиечестве проверок, работает не стабильно).

Installation

Add this line to your application's Gemfile:

gem 'fnsapi', github: 'actie/fnsapi'

Then:

$ bundle

Configuration

You can configure this gem in config/initializers/fnsapi.rb:

Fnsapi.configure do |config|
  config.redis_url = ENV.fetch('REDIS_URL')
  config.fnsapi_master_key = ENV.fetch('FNS_API_MASTER_KEY')
  config.fnsapi_user_token = ENV.fetch('FNS_API_USER_TOKEN')
end

The only one parameter, which you must specify is fnsapi_master_key. And if you want to store temporary credentials in redis specify redis_url. If you don't credentials will be stored in the tmp file.

The full parameters list for configuration with default values:

fns_host = 'https://openapi.nalog.ru'
fns_port = 8090
redis_key = :fnsapi_token
redis_url = nil
tmp_file_name = 'fnsapi_tmp_credentials'
fnsapi_master_key = nil
fnsapi_user_token = nil
get_message_timeout = 60
log_enabled = false
logger = Logger.new($stdout)

get message timeout

FNS provides us an asynchronous API. So, we need to make two requests: first to generate the message, and second to receive it. And there is a timeout on a server side. It's possible to download the message only within around the 60 seconds after request. We use the exponential backoff algorithm with 60 seconds timeout. You can specify the different value but if it is too big, you'll just receive the TimeoutException from FNS backend.

log_enabled

If this option id true, all SAVON logs will be written in logger.

logger

By default it's a stdout stream but if you use this gem with Rails application, logger will be configurated as Rails.logger automaticaly.

Usage

There are two methods:

 # Is check data correct?
Fnsapi.check_data(ticket, user_id) # true / false
# Give me full information about check: products, INN etc.
Fnsapi.get_data(ticket, user_id)

ticket could be both an object which implements methods or a hash with the same keys:

fn - Fiscal number
fd - Fiscal document id
pfd - Fiscal signature
purchase_date - Ticket purchase date with time (we have tested for Moscow timezone but this point is not documented, and FNS API don't acept time with timezone, so I don't sure what timezone can you use.)
amount_cents - Ticket amount in cents (Integer)

user_id - is an optional parameter. You can send the ID for user in you system if you want to specify which person do this request. In other way it has a default value 'default_user'.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/actie/fnsapi.

License

The gem is available as open source under the terms of the MIT License.