reseller-api-docs
The API ensures that communication with the MyWheels platform is fast and reliable.
Communication with the MyWheels API goes through a POST request to the desired endpoint.
You need to be authenticated first before you can access any endpoint.
MyWheels uses json rpc 2.0 to communicate with clients. This protocol is designed to simulate a function call over the network. So in the documentation we'll talk about function calls all the time. There are many good clients for json rpc, it is advisable to use a function library.
Headers
These two headers are required so we can determine if the user is authenticated, has access to the endpoints and from which client the request is coming from.
The client_id will be provided by MyWheels.
The access_token can be retrieved through the authentication request
| Key | Value |
|---|---|
| X-Simple-Auth-App-Id | {client_id} |
| X-Simple-Auth-Digest | {access_token} |
JsonRPC Body
The JsonRPC request body expects to be a valid json format or an array with json objects in it if you want to execute multiple request at once.
A set of properties are required inside of the json object to make it a valid JsonRPC object which we can process through our API.
| Property | Value | Description |
|---|---|---|
jsonrpc |
2.0 |
The version of JsonRPC |
method |
namespace.method |
Every functionality has it owns namespace with a couple of method |
params |
JsonRpcObject |
The needed parameters to execute a method properly |
Example
{
"jsonrpc": "2.0",
"id": 1,
"method": "reseller.getOrganizations",
"params": {
"limit": 10
}
}
First step: authentication, or checkout the example request
Endpoints
Authentication
Account
Booking
Company
-
Subscribe
⚠️ deprecated⚠️
Contract
Invoice
Organization
Rental country
Reseller
-
Get companies
⚠️ deprecated⚠️ - Get organizations
- Unsubscribe user
- Transfer user to organization