Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guibranco/guistracini.mandae
:truck: Mandaê API .NET client wrapper
https://github.com/guibranco/guistracini.mandae
api courier courier-partners delivery delivery-api delivery-service hacktoberfest mandae mandae-api orders postal shipping shipping-and-delivery shipping-api shipping-rates shipping-service-provider transport wrapper
Last synced: 19 days ago
JSON representation
:truck: Mandaê API .NET client wrapper
- Host: GitHub
- URL: https://github.com/guibranco/guistracini.mandae
- Owner: guibranco
- License: mit
- Created: 2017-09-28T12:20:20.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T06:17:24.000Z (7 months ago)
- Last Synced: 2024-04-09T06:39:22.004Z (7 months ago)
- Topics: api, courier, courier-partners, delivery, delivery-api, delivery-service, hacktoberfest, mandae, mandae-api, orders, postal, shipping, shipping-and-delivery, shipping-api, shipping-rates, shipping-service-provider, transport, wrapper
- Language: C#
- Homepage: https://guibranco.github.io/GuiStracini.Mandae/
- Size: 1.82 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Mandaê SDK .NET
🇧🇷🚚 Mandaê API .NET client wrapper
Para a versão em português, por favor [siga me](/README.pt-br.md).
[](https://github.com/guibranco/GuiStracini.Mandae)
[](https://wakatime.com/badge/github/guibranco/GuiStracini.Mandae)
[](https://github.com/guibranco/guistracini.mandae/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
This is an **unofficial** client for the [Mandaê API V2](https://dev.mandae.com.br/api/index.html)
---
## CI/CD
| Build status | Last commit | Tests | Coverage | Code Smells | LoC |
|--------------|-------------|-------|----------|-------------|-----|
| [](https://ci.appveyor.com/project/guibranco/guistracini-mandae/branch/main) | [](https://github.com/guibranco/GuiStracini.Mandae) | [](https://ci.appveyor.com/project/guibranco/guistracini-mandae) | [](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae) | [](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae) | [](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae) |
## Code Quality (main branch)
[](https://www.codacy.com/gh/guibranco/GuiStracini.Mandae/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/GuiStracini.Mandae&utm_campaign=Badge_Grade)
[](https://www.codacy.com/gh/guibranco/GuiStracini.Mandae/dashboard?utm_source=github.com&utm_medium=referral&utm_content=guibranco/GuiStracini.Mandae&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/guibranco/GuiStracini.Mandae)
[](https://www.codefactor.io/repository/github/guibranco/GuiStracini.Mandae)
[](https://codeclimate.com/github/guibranco/GuiStracini.Mandae/maintainability)
[](https://codeclimate.com/github/guibranco/GuiStracini.Mandae/test_coverage)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://sonarcloud.io/dashboard?id=guibranco_GuiStracini.Mandae)
[](https://app.deepsource.com/gh/guibranco/GuiStracini.Mandae/?ref=repository-badge)
---
## Installation
### Github Releases
[](https://github.com/guibranco/GuiStracini.Mandae) [](https://github.com/guibranco/GuiStracini.Mandae)
Download the latest zip file from the [Release](https://github.com/GuiBranco/GuiStracini.Mandae/releases) page.
### Nuget package manager
| Package | Version | Downloads |
|------------------|:-------:|:-------:|
| **GuiStracini.Mandae** | [](https://www.nuget.org/packages/GuiStracini.Mandae/) | [](https://www.nuget.org/packages/GuiStracini.Mandae/) |
---
## Features
This client supports the following operations/features of the API:
1. Get rates for a delivery (postal code and package dimensions)
2. Schedule a collect (register a collect in the customer distribution centre with one or more packages. Each package can have one or more items/SKU)
3. Get tracking data of a shipment (Get all tracking data available from one package - tracking code is set by the customer or provided by webhook)
4. WebHooks schema ready (The webhooks models, ready for implementation)
5. **Experimental** Querying orders (API V1 - non-public API)
6. **Experimental** Querying occurrences (API V1 - non-public API). [Issue #1](https://github.com/guibranco/GuiStracini.Mandae/issues/1) 
7. **Experimental** Querying reverses (API V1 - non-public API). [Issue #2](https://github.com/guibranco/GuiStracini.Mandae/issues/2) 
8. **Experimental** Request reverse (API V1 - non-public API). [Issue #3](https://github.com/guibranco/GuiStracini.Mandae/issues/3) 
---
## Usage
### Setup the MandaeClient
Initializes a new instance of **MandaeClient** class.
Example:
```csharp
//Request your API token to [email protected]
//Each environment has its own API token!
var apiToken = "my API token";
//Call the constructor with the API token and the API environment (SANDBOX | PRODUCTION).
//var client = new MandaeClient(apiToken); //<= Environment.SANDBOX is the default environment.
var client = new MandaeClient(apiToken, Environment.PRODUCTION);
```
### Get rates for a package/delivery
Get the rates (Rápido & Econômico) values and delivery time for a specified postal code and package dimensions.
Example:
```csharp
//The MandaeClient
var client = new MandaeClient("my API token");
//The RatesModel
var delivery = new RatesModel {
PostalCode = "22041080",
...
}
var rates = client.GetRates(delivery);
var fast = rates.ShippingServices.Single(s => s.Name == "Rápido");
var economic = rates.ShippingServices.Single(s => s.Name == "Econômico");
var option = ShippingService.ECONOMICO;
if(fast.Price < economic.Price)
option = ShippingService.RAPIDO;
//The OrderModel (order collect request model)
var order = new OrderModel { ... };
order.Items = new [] {
new NewItem
{
....
ShippingService = option
}
};
var order = client.RegisterOrderCollectRequest(order);
```
### Schedule a collect request
Schedule a collect request (pickup in a distribution center/origin location).
Inform which type of Vehicle, when, which rate (Rapido | Economico) and the order items (a.k.a packages or clients orders).
Each package means an order/volume, that can have one or more items (SKUs).
Example:
```csharp
//The MandaeClient
var client = new MandaeClient("my API token");
//The OrderModel (order collect request model)
var order = new OrderModel { ... };
order.Items = new [] {
new NewItem
{
....
ShippingService = option
}
};
//Makes the request
var order = client.RegisterOrderCollectRequest(order);
**
//order.Id is the id for further use (maybe cancel the request ?)
```
### Get tracking of a package
Example:
```csharp
//The MandaeClient
var client = new MandaeClient("my API token");
//The tracking identifier (Generated by the Mandae or sent by the order collection request
var trackingId = "MyCompany-00001";
var tracking = client.GetTracking(tracking);
//tracking.CarrierName;
//tracking.CarrierCode;
//tracking.Events;
```
### Querying orders (API V1 - Search) EXPERIMENTAL/NON-PUBLIC API
For the V1 you'll need to use the e-mail/password combination of the Mandaê panel to log in V1 API.
Example:
```csharp
//The MandaeClient
var client = new MandaeClient("V2 API token");
client.ConfigureV1Authentication("[email protected]", "password");
var trackingCode = "XYZ000001";//The tracking code of some order
var result = client.Search(SearchMethod.TRACKING_CODE, trackingCode);
if(result.Total == 1)
Console.WriteLine(result.Orders.Single().SituationDescription);
```
---
## Release notes
- Release v6.0.0 and higher DEPRECATED methods: Get Latest Order
- Release v5.0.0 and higher DEPRECATED methods: Large Request, Cancel Request, Cancel Item Request
- Release v3.0.0 and higher changes the V1 authentication method. Now use your e-mail/password of the Mandaê panel to log in to the V1 API.
- Release v1.4.1 and higher also includes an experimental (non-public) V1 endpoint for search/querying orders (the same interface as available through the Mandaê administration panel).
> **Warning**
>
> The API V1 is not officially public, so there is no warranty that it will still be working
---