cbourgois / ovh-api-services

Contains all angular $resource for OVH API

ovh-api-services

Contains all $resource for API.

Table of contents

• Installation
• Usage

Installation

Download module with bower

$ bower install ovh-api-services --save

Download module with NPM

$ npm install ovh-api-services --save

• Add Angular dependency "ovh-api-services"
• Load files via wiredep, or manually

This will also download the dependencies.

Usage

All services must return a $resource. For each $resource, you can call whether:

• v6: for APIv6
• v7: for APIv7 (see ovh-angular-apiv7 library)
• Aapi: for 2API

For example, for the service Me, use OvhApiMe.v6().get(), to get user informations.

If you want the sshKeys of the user, use OvhApiMe.v6().SshKey().get().

The files structure is then:

.
└── me
    ├── sshKey
    │   ├── me-sshKey.service.js
    │   └── me-sshKey.v6.service.js
    ├── me.service.js
    └── me.v6.service.js

The directories structure must follow the structure of the API.

Contributing

You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!

Have a look in CONTRIBUTING.md

Run the tests

$ npm test

Related links

• Contribute: https://github.com/ovh-ux/ovh-api-services/blob/master/CONTRIBUTING.md
• Report bugs: https://github.com/ovh-ux/ovh-api-services/issues
• Get latest version: https://github.com/ovh-ux/ovh-api-services

License

See https://github.com/ovh-ux/ovh-api-services/blob/master/LICENSE