Skip to content

jancotanis/integra365

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Integra Office365 backup API

Version Maintainability Test Coverage

This is a wrapper for the Integra Office365 backup API. You can see the API endpoints here https://api.integra-bcs.nl/swagger/index.html

Currently only the GET requests to get a list of tenants and backup job reports are implemented.

Installation

Add this line to your application's Gemfile:

gem 'integra365'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install integra365

Usage

Before you start making the requests to API provide the client id and client secret and email/password using the configuration wrapping.

require 'integra365'

Integra365.configure do |config|
  config.username = ENV["INTEGRA365_USER"]
  config.password = ENV["INTEGRA365_PASSWORD"]
end

client = Integra365.client
client.login

tenants = client.tenants
tenants.each do |t|
  puts "#{t.friendlyName} - #{t.tenantName}"
end

Resources

Authentication

# setup configuration
#
client.login
Resource API endpoint Description
.token or .login /Api/V1/Token portal user
.token_refresh /Api/V1/Token/Refresh Refresh authentication token

Tenant

Endpoint for tenant related requests

licenses = client.tenant_licenses
Resource API endpoint
.tenants /Api/V1/Tenants/{id}
.get_tenant_by_id(id) .tenant(id) /Api/V1/Tenants/{id}
.tenant_licenses(id) /Api/V1/Tenants/{id}/Licenses
.tenant_storage(id) /Api/V1/Tenants/{id}/Storage

BackupJobReporting

BackupJobReporting for status of backup jobs

job_statuses = client.backup_job_reporting
Resource API endpoint
.backup_job_reporting /Api/V1/BackupJobReporting

Contributing

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

License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages