SuperSaaSApiClient 1.0.0

SuperSaaSApiClient 1.0.0

×

Maintained by SuperSaaS.

SuperSaaSApiClient 1.0.0

SuperSaaS Objective-C API Client

Online bookings/appointments/calendars in Ruby using the SuperSaaS scheduling platform - https://supersaas.com

The SuperSaaS API provides services that can be used to add online booking and scheduling functionality to an existing website or CRM software.

Prerequisites

  1. Register for a (free) SuperSaaS account, and
  2. get your account name and API key on the Account Info page.
Dependencies

iOs 7 or greater, or else OSX 10.8 or greater.

No external libraries. Only the native NSJSONSerialization and NSURLRequest standard libs are used.

Installation

SuperSaaSApiClient is available through CocoaPods. To install it, simply add the following line to your Podfile and run pod install:

pod 'SuperSaaSApiClient'

Configuration

Initialize the SSSClient and set the authorization credentials:

SSSClient *client = [[SSSClient alloc] init];
client.accountName = @"accnt";
client.config.api_key = @"xxxxxxxxxxxxxxxxxxxxxx";
client.test = false

API Methods

Details of the data structures, parameters, and values can be found on the developer documentation site:

https://www.supersaas.com/info/dev

Create User

Update User

Delete User

Get User

List Users

Create Appointment/Booking

Update Appointment/Booking

Delete Appointment/Booking

Get Appointment/Booking

List Appointments/Bookings

Get Agenda

Get Agenda Slots

Get Available Appointments/Bookings

Get Recent Changes

Get Recent Changes Slots

List Template Forms

Get Form

Examples

To run the example project, clone the repo, and run pod install from the Example directory first.

Testing

The HTTP requests can be stubbed by configuring the client with the test option, e.g.

SSSClient.test = true;

Note, stubbed requests always return an empty NSURLSessionDataTask.

The Client also provides a lastRequest attribute containing the NSURLRequest object from the last performed request, e.g.

SSSClient.lastRequest //=> <Net::HTTP::Get>

The headers, body, path, etc. of the last request can be inspected for assertion in tests, or for troubleshooting failed API requests.

Additional Information

Contact: [email protected]

Releases

The package follows semantic versioning, i.e. MAJOR.MINOR.PATCH

License

The SuperSaaS Ruby API Client is available under the MIT license. See the LICENSE file for more info.