Alzabox.API.SDK 0.0.16

AlzaBox-API-SDK-csharp

• Preview of opensource libraries for easier use of AlzaBox API.
• Warning! Use it for your own risk, now.
• This project is licensed under the terms of the MIT license.

How to communicate?

We can communicate with each other on discord completely openly, without prejudices, without worries, but also without guarantees!

Link to discord server

How to be happy

The happy path scenario is marked with a white background. In this case, you just need to use the Reserve method and learn to receive callbacks.

AlzaBoxClient

• has contructor with parameters to set test or production environment.
• has login method to authenticate by your credentials
• has boxes and reservation properties which divide API methods by domain

Methods

• Boxes.GetAll
• Boxes.Get
• Reservation.GetAll
• Reservation.Get
• Reservetion.Reserve
• Reservation.Extend
• Reservation.Cancel
• Reservation.Lock
• Reservation.Unlock
• Courier.Get
• Courier.Create

Credentials

If you don't have any credentials for connecting to AlzaBox API, please contact our business key account at ...

Sample usage

Base commuication client class is AlzaBoxClient. If you don't use any constructor parameters, the test url for IDM will be set as well as the test url for AlzaBox API.

var id = $"RES{Guid.NewGuid()}";
var alzaBoxClient = new AlzaBox.API.Clients.AlzaBoxClient();
var response0 = await alzaBoxClient.Login(args[0],args[1], args[2], args[3]);
var response1 = await alzaBoxClient.Boxes.GetAll();
var response2 = await alzaBoxClient.Reservations.Reserve(id, response1.Data[0].Id, $"PKG{Guid.NewGuid()}", 24);
var response3 = await alzaBoxClient.Reservations.GetStatus(id);
var response4 = await alzaBoxClient.Reservations.Extend(id, 48);
var response5 = await alzaBoxClient.Reservations.Lock(id);
var response6 = await alzaBoxClient.Reservations.Unlock(id);
var response7 = await alzaBoxClient.Reservations.Cancel(id);

Next steps

• Completing the models property description
• DTO for Callbacks
• Nuget package