0.0
No release in over a year
Access the Credly REST API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 1.0, >= 1.0.0
 Project Readme

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:

gem 'credly-ruby'

Then bundle install.

Usage

Quick Start

client = Credly::Client.new(auth_token: 'my_organization_token')

client.badge_list(organization_id)

The Client class also accepts the following options:

Option Type Description Default
sandbox boolean Whether to use the sandbox environment. false
version string The 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

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

License

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