APIs

Application Registration in MAGIIS:

It is mandatory having an active MAGIIS account:

  • Livery Service Company Account or Contractor account
  • If it´s Contractor must have at least one Livery Service company associate

Steps:

  1. Log in with a Supervisor profile.
  2. Select from menu Integrations -> MAGIIS APIs. Click Administration.
  3. Click in Add Application (wizard guided process).
    1. Enter application NAME and it´s description.
    2. Enter Username and generate Password.
      Note: Keep the generated password . It won´t be posible access again after de process be completed.
    3. Select the role that would access to the publicated services

Service: Authentication

After Application registration and User & Password authentification, this service Will return the token needed to use the MAGIIS services.

Resource
POST https://api.public.magiis.com/auth/login
Request Parameters:

Header

RoleToAttempt = <Empty>

Input [body]

{
"password": "<Password generated during Application registration process>",
"username": "<UserName generated for the Aplication>"
}
Answer Parameters

Output

{
"token": "Bearer eyJhbGciOiJIUzUxMiJ……"
}

Service: New Trip

Resource
POST https://api.public.magiis.com/trip/create
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{"origin": {
   "latitude": "-38.045754",
   "longitude": "-57.3422546",
   "shortName": "<Requested Address description name >"
},
"destination": {
   "latitude": "-38.0243244",
   "longitue": "-57.572348",
   "shortName": "<Requested Address description name >"
},
"passengerUserId": <ID Pasajero>,
"guestPassengerName": "<Guest Passenger Name>", (Optional)
"serviceType": <Service type ID >,
"generatedTravel": <0: Trip Budget | 1: Generate Trip>
}
Answer Parameters

Output
Trip Quote List: Trip Services Quote List

[
{
"distance": 1.76,
"pricePointToPoint": 100.00,
"duration": "4 min",
"origin": {
   "latitude": "-38.0237654",
   "longitude": "-57.5745646",
   "shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"destination": {
   "latitude": "-38.524914",
   "longitude": "-57.877348",
   "shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"serviceType": 1,
"serviceName": "Standard"
},
{
"distance": 1.76,
"pricePointToPoint": 200.00,
"duration": "4 min",
"origin": {
   "latitude": "-38.0237654",
   "longitude": "-57.5745646",
   "shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"destination": {
   "latitude": "-38.524914",
   "longitude": "-57.877348",
   "shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"serviceType": 2,
"serviceName": "Executive"
}
]

Generate Trip: One element List

[
{
"travelIdForCarrier": 1399,
"passengerFirstName": "<Passenger Name>",
"passengerLast Name": "<Passenger Last Name>",
"origin": "<Address> <Number>, <City>, <Estate>, <Country>",
"destination": "<Address> <Number>, <City>, <Estate>, <Country>",
"originPlatform": "Web",
"creationDate": "2020-11-12T13:16:02.038Z",
"paymentMethod": "CASH",
"simulatePrice": 100.00,
"serviceType": "Standard",
"avoidTolls": false,
"avoidHighways": false
}
]

Service: Trip Cancelation

Resource
POST https://api.public.magiis.com/trip/cancel
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{
"travelIdForCarrier": <Trip ID to Cancel>,
"cancelReason": "<Description of the reason for cancellation>"
}
Answer Parameters

Output

{
"status": "SUCCESS",
"cancelCost": 0,
"currencyCode": "ARS",
"message": "Trip <ID Trip> canceled."
}

Service: Trips Report

Resource
POST https://api.public.magiis.com/trip/query/list
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{
"dateFrom": "2020-11-12",
"dateTo": "2020-11-12",
"page": 1
}
Answer Parameters

Output

{
"page": {
"content": [
{
"travelIdForCarrier": 1393,
"state": "CANCELLED",
"passengerFirstName": "<Passenger Name>",
"passengerLast Name": "<Passenger Last Name>",
"driverFirstName": null,
"driverLast Name": null,
"vehicleMark": null,
"vehicleModel": null,
"vehicleDomain": null,
"carPlate": null,
"origin": "<Address> <Number>, <City>, <Estate>, <Country>",
"destination": "<Address> <Number>, <City>, <Estate>, <Country>",
"creationDate": "2020-11-12T10:55:47.785Z",
"finalPrice": null,
"isProgrammed": false,
"paymentMethod": "CASH",
"simulatePrice": 166.29,
"waypoints": null,
"serviceType": "Standard",
"avoidTolls": false,
"avoidHighways": false,
"delivery": false
},
{
"travelIdForCarrier": 1394,
"state": "DONE",
"passengerFirstName": "<Passenger Name>",
"passengerLast Name": "<Passenger Last Name>",
"driverFirstName": "<Driver Name>",
"driverLast Name": "<Driver Last Name>",
"vehicleMark": "Renault",
"vehicleModel": "Laguna",
"vehicleDomain": "AD696KS",
"carPlate": "AD696KS",
"origin": "<Address> <Number>, <City>, <Estate>, <Country>",
"destination": "<Address> <Number>, <City>, <Estate>, <Country>",
"creationDate": "2020-11-12T11:41:32.310Z",
"finalPrice": 166,
"isProgrammed": false,
"paymentMethod": "CASH",
"simulatePrice": 166.29,
"waypoints": null,
"serviceType": "Blindado",
"avoidTolls": false,
"avoidHighways": false,
"delivery": false
}, …
],
"currentElementsQty": 8,
"totalElements": 8,
"currentPage": 1,
"totalPages": 1
}
}

Service: Trip Details

Resource
POST https://api.public.magiis.com/trip/query/details
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{
"travelIdForCarrier": <ID Trip>
}
Answer Parameters

Output

{
"travelId": 9030,
"travelIdForCarrier": 1400,
"passengerFirstName": "<Passenger Name>",
"passengerLast Name": "<Passenger Last Name>",
"passengerPhone": "<Passenger Phone>",
"passengerEmail": "<Passenger Email>",
"hasGuestPassenger": false,
"guestPassengerName": null,
"requesterUser": "<Reuqester Name>",
"travelDuration": null,
"driverFirstName": "<Driver Name>",
"driverLast Name": "Driver Last Name",
"origin": {
"latitude": "-37.0695022",
"longitude": "-57.073078",
"shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"destination": {
"latitude": "-38.9011986",
"longitude": "-57.9441034",
"shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"vehicleDescription": "Ford - Focus",
"vehicleDomain": "PIK302",
"paymentMethod": "CASH",
"amount": 0,
"tourPrice": 0,
"roundTrip": false,
"waitTimePrice": null,
"isCorporate": false,
"delay": 0,
"parking": 0,
"roadToll": 0,
"state": "CANCELLED",
"reasonForCancellation": null,
"kilometers": 0,
"stops": 0,
"note": null,
"isDelivery": false,
"travelDate": "2020-11-12T13:18:08.642+0000",
"transportType": "Standard",
"isProgrammed": false,
"travelRating": null,
"simulationPrice": {
"distance": 5.58,
"pricePointToPoint": 171.06,
"duration": "13 min",
"origin": {
"latitude": "-37.0695022",
"longitude": "-57.073078",
"shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"destination": {
"latitude": "-38.0011086",
"longitude": "-57.0441034",
"shortName": "<Address> <Number>, <City>, <Estate>, <Country>"
},
"roundTrip": null,
"limit": null,
"rental": null,
"rentType": null,
"waypoints": null
},
"waitDetailList": null,
"waypoints": null,
"avoidHighways": false,
"avoidTolls": false,
"recurringTrip": false,
"originPlatform": "Android",
"isRental": false,
"rentType": null,
"tollList": null,
"parkingList": null
}

Service: Checking Account & Balances Report

Resource
POST https://api.public.magiis.com/client/checking_account_balance/query/list
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{
"page": 1
}
Answer Parameters

Output

{
"currencyCode": "ARS",
"content": [
{
"checkingAccountId": 1241,
"name": "<Company Name>",
"passengerClass": "COMPANY",
"balance": -1854,
"limit": 20000
},
{
"checkingAccountId": 1220,
"name": "<Last Name>, <Name>",
"passengerClass": "INDIVIDUAL",
"balance": 0,
"limit": 5000
},
{
"checkingAccountId": 1160,
"name": "<Last Name>, <Name>",
"passengerClass": "INDIVIDUAL",
"balance": 31,
"limit": 2000
},…
],
"currentElementsQty": 16,
"totalElements": 16,
"currentPage": 1,
"totalPages": 1
}

Service: Checking Account & Balances Report

Resource
POST https://api.public.magiis.com/client/checking_account/query/detail
Request Parameters

Header

Authorization= <Generated Token>
ApplicationName= <UserName generated during the process>

Input [Body]

{
"checkingAccountId": 1241,
"dateFrom": "2020-10-01",
"dateTo": "2020-10-19",
"page": 1
}
Answer Parameters

Output

{
"currencyCode": "ARS",
"content": [
{
"creationDate": "2020-10-15T13:34:20.541+0000",
"travelIdForCarrier": null,
"concept": "Pago",
"costCenter": null,
"passengerName": null,
"debit": 0,
"credit": 800,
"balance": -911
},
{
"creationDate": "2020-10-15T13:26:10.139+0000",
"travelIdForCarrier": null,
"concept": "Pago",
"costCenter": null,
"passengerName": null,
"debit": 0,
"credit": 111,
"balance": -111
}
],
"currentElementsQty": 2,
"totalElements": 2,
"currentPage": 1,
"totalPages": 1
}