Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.47 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.47 KB

vzaar API

vzaar Logo

By vzaar

vzaar's .NET client for interacting with version 2 of the vzaar API.

Requirements

The library code compiles on:

  • Mono 4.6.2 / .NET 45
  • .NET Core 1.0 / .NET Standard >=1.3

Backwards compatability

Versions 1 and 2 of the vzaar API are incompatable with each other. The same applies to the API SDKs. Some functionality available in the version 1 SDK has been deprecated in version 2 and will not be implemented. The version 2 API also has a different authentication mechanism so your existing API key will not work with version 2 SDKs.

To ease migration to the version 2 SDK, it is possible to use both versions without any conflicts.

Vzaar       # <= this is version 1
VzaarApi    # <= this is version 2

Usage

Check the Examples directory for usage examples. You can configure your client_id and auth_token in Program.cs:


Client.client_id = "id";
Client.auth_token = "token";

Usage instructions and examples are available on vzaar's documentation site.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Released under the MIT License.