Gem Version CircleCI

Credly Ruby

An API client for the Credly REST API in ruby.

Credly API documentation can be found here:

https://www.credly.com/docs/

Installation

Add to your Gemfile:

“by gem ‘credly-ruby’

Then bundle install.

Usage

Quick Start

“by client = Credly::Client.new(auth_token: ‘my_organization_token’)

client.badge_list(organization_id)

The Client class also accepts the following options:

OptionTypeDescriptionDefault
sandboxbooleanWhether to use the sandbox environment.false
versionstringThe API version to use.v1

Additional request examples can be found in https://github.com/riipen/credly-ruby/blob/main/spec/credly-ruby/actions

Errors

Any error code returned by the Credly API will result in one of the following expections

CodeException
400Credly::BadRequest
401Credly::Unauthorized
403Credly::Forbidden
404Credly::NotFound
410Credly::Gone
4xxCredly::ClientError
500Credly::InternalServerError
503Credly::ServiceUnavailable
5xxCredly::ServerError

License

Copyright (C) 2023 Riipen. See LICENSE for details.