Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 2.97 KB

README.md

File metadata and controls

96 lines (66 loc) · 2.97 KB
Raw

Vindi Ruby

Build Status

Descrição

Ruby toolkit para a API de Recorrência da Vindi.

Requisitos

  • Ruby >=2.3;
  • Certificado digital HTTPS assinado por uma entidade certificadora;
  • Conta ativa na Vindi.

Instalação

gem 'vindi'

Então execute:

$ bundle

Ou instale você mesmo:

$ gem install vindi

Uso

Os métodos da API estão disponíveis atraves dos métodos da instancia de um cliente

  client = Vindi::Client.new(key: '<sua_vindi_api_key>')

Para testar no ambiente Sandbox, use o endpoint da API para efetuar requisições:

  client = Vindi::Client.new(key: '<sua_vindi_api_key>', api_endpoint: 'https://sandbox-app.vindi.com.br/api/v1')

Caso prefira utilizar variáveis de ambiente para prover credenciais de acesso:

export VINDI_KEY="<sua_vindi_api_key>"
export VINDI_API_ENDPOINT="https://sandbox-app.vindi.com.br/api/v1"

Consumindo recursos

Os recursos são fornecidos através do objeto de retorno e os campos retornados podem ser acessados pela notação de attributos de um Hash

  # Listando planos de um lojista
  client.list_plans
  # => [{:id=>15, :name=>"My awesome plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...

  # Consultando um plano
  client.plan(15)
  # => {:id=>15, :name=>"My awesome plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...

  # Atualizando um plano
  client.update_plan(15, {name: 'My plan'})
  # => {:id=>15, :name=>"My plan", :interval=>"months", :interval_count=>1, :billing_trigger_type=>"beginning_of_period" ...

  # Criando um plano
  client.create_plan({name: 'My new plan', interval: 'months', interval_count: 1,  billing_trigger_type: 'beginning_of_period'})

Acessando respostas HTTP

  client.list_plans
  response  = client.last_response
  status = response.status

Dúvidas

Caso necessite de informações sobre a plataforma ou API, por favor acesse o Atendimento Vindi.

Segurança

Se você descobrir qualquer questão relacionada a segurança, por favor, envie um e-mail para [email protected] ao invés de utilizar os issues.

Changelog

Todas as informações sobre cada release podem ser consultadas em CHANGELOG.md.

Créditos

Licença

GNU GPLv3. Por favor, veja o Arquivo de Licença para mais informações.