{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1f3675e7-a961-4d23-8782-77ec7b1e28dc","name":"Documentación API Drivin","description":"\n\nBienvenidos a la documentación APIs de Drivin. \nAquí encontrarás todo lo necesario para poder integrar a Drivin con tus sistemas.\n\nAntes de comenzar, es importante que sepas que los servicios que encontrarás disponibles en esta documentación, te permitirán crear, consultar, modificar y eliminar información a través de un protocolo RESTful.\n\nAhora que ya conoces nuestro protocolo, te aconsejamos que hagas una revisión de la documentación y luego puedas definir el flujo de integración entre Drivin y sus sistemas (que información será necesaria para la operación), cualquier duda que tengan con respecto a los servicios o bien no encuentren las API correctas, no duden en contactarnos a [soporte@driv.in](https://mailto:soporte@driv.in).\n\n# Principales definiciones que debes de conocer al utilizar Drivin:\n\n**\\- Organización:** \nEs básicamente tu cuenta, con la que podrás operar en Drivin (Cada organización tiene su propio api_key).\n\n**\\- Tripulación:** \nCorresponde al usuario tipo **conductor** o _\\*asistente_. Estos usuarios podrán hacer uso de la aplicación móvil para ir gestionando la ruta.\n\n**\\- Depósito:** \nUn deposito es un Centro de Distribución, bodega o el lugar físico desde donde comienzan y/o finalizan las rutas. Puedes configurar uno o varios depósitos.\n\n**\\- Esquema:** \nUn esquema es donde se definen todas las restricciones y parámetros que se evalúan al momento de planificar las rutas. \nAdemás, en Drivin podemos soportar varios tipos de operación en el mismo depósito.\n\n**\\- Orden:** \nUna orden corresponde a una visita a una dirección, esta podria ser de tipo entrega, retiro, servicio, etc...\n\n**\\- Escenario (Plan):** \nObjeto utilizado para la creación de rutas en base a una fecha de operación, un esquema, vehículos y ordenes.\n\n**\\- Ruta:** \nUna ruta se conforma por uno o más viajes, la cual tiene asignado un vehículo, un conductor y opcionalmente un asistente, ordenes.\n\n**\\- Viaje:** \nUn viaje se conforma de una o varias ordenes.\n\n# Tipos de Planificación:\n\n**1\\. Planificación normal:** \nLa optimización normal busca reducir al mínimo la flota a utilizar en el escenario y los kilómetros recorridos para poder gestionar todas las ordenes, se encarga de optimizar recursos.\n\n**2\\. Planificación con asignación:** \nEn la optimización con asignación, tú como cliente nos dices en qué vehículo va cada orden y Drivin lo que hace es optimizar la secuencia de entrega de cada uno de los vehículos, con el fin de cumplir con las ventanas horarias existentes y recorrer la menor cantidad de kilómetros.\n\n**3\\. Planificación balanceada:** \nLa optimización balanceada es perfecta para cuando quieres distribuir equitativamente la carga de trabajo, por lo tanto optimizaremos tu escenario asignando la misma cantidad de direcciones por vehículo.\n\n**4\\. Planificación Flota Entera:** \nLa optimización de flota entera utilizará todos los vehículos y no necesariamente distribuirá de manera equitativa la cantidad de direcciones por vehículo.\n\n# Flujo de procesos:\n\nFlujo utilizando las siguientes APIs:\n\n1.Usuarios, Vehiculos, Esquema, Direcciones, Ordenes:\n\n\n\n2.Usuarios, Esquema, Escenario:\n\n\n\n3.Usuarios, esquema, rutas:\n\n\n\n# Configuración y primeras pruebas\n\nSi ya revisaste la documentación y quieres realizar las primeras pruebas, necesitamos que te contactes con nosotros a [soporte@driv.in](https://mailto:soporte@driv.in) para poder crear tu organización en ambiente de QA y entregarte tu `api_key`, que será la forma en la que te autenticarás en Drivin.\n\nCuando ya conozcas tu api_kay, debes configurar dos Headers:\n\n**1\\. X-API-KEY**\n\n**2\\. Content-Type: application/json**\n\n_(Para confirmar que configuraste bien los Headers debieras recibir como respuesta un_ `_HTTP 200 OK_`_**__**__****__**__)_\n\n_Las url configuradas en cada carpeta corresponden a url de producción, la url de ambiente QA es la siguiente:_ [https://external-qa.driv.in/](https://external-qa.driv.in/)\n\n# **IMPORTANTE:**\n\nCompatibilidad y cambios en la API:\n\n- La API evoluciona continuamente y puede incorporar **nuevos campos en los request y response**\n \n- **La adición de nuevos campos no se considera un cambio disruptivo**, ya que los campos previamente documentados se mantendrán sin modificaciones.\n \n- Los clientes deben implementar **parseo tolerante**, ignorando campos desconocidos y basando su integración únicamente en los parámetros documentados como requeridos.\n \n- Los **cambios disruptivos** (por ejemplo: eliminación o renombrado de campos existentes, cambios de tipo de datos o de semántica) se introducirán únicamente en **nuevas versiones mayores de la API**, y serán anunciados con anticipación a través de la documentación y canales oficiales.\n \n\n**La configuración de la BBDD no permite crear identificadores únicos y códigos con caracteres especiales o Ñ, se debe tomar en cuenta al momento de generar llamadas POST que incluyan estos campos.**\n\nSe deben tener en cuenta las siguientes respuestas comunes de las APIs: \n**200 OK** → La solicitud fue procesada correctamente y se devolvió la respuesta esperada. \n**400 Bad Request** → La solicitud es inválida debido a datos mal formados o parámetros incorrectos enviados por el cliente. \n**401 Unauthorized** → El cliente no está autenticado o la autenticación falló (por ejemplo, API key inválida). \n**404 Not Found** → El recurso solicitado no existe o no se encuentra disponible. \n**429 Too Many Requests** → Se enviaron demasiadas solicitudes en un periodo de tiempo determinado (límite de _rate limit_ excedido). \n**500 Internal Server Error** → Ocurrió un error inesperado en el servidor al procesar la solicitud. \n**502 Bad Gateway** → Un servidor que actúa como _proxy_ o _gateway_ recibió una respuesta inválida o no recibió respuesta del servidor de origen.\n\nTanto para el **502** como para el **500**, la mejor práctica es implementar una política de reintentos con breves pausas de tiempo. Si tras 3 intentos el error 500 persiste, se debe escalar a soporte técnico para revisar los logs, ya que lo más probable es que sea un fallo en el código y no algo temporal. \n \n\n# Preguntas, Comentarios y Sugerencias\n\nSi tienes cualquier comentario o sugerencia, envíanos un correo a [soporte@driv.in](https://mailto:soporte@driv.in).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3830854","team":112137,"collectionId":"1f3675e7-a961-4d23-8782-77ec7b1e28dc","publishedId":"UzBqoQbJ","public":true,"publicUrl":"https://apidocs.driv.in","privateUrl":"https://go.postman.co/documentation/3830854-1f3675e7-a961-4d23-8782-77ec7b1e28dc","customColor":{"top-bar":"101828","right-sidebar":"101828","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-06-24T00:43:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/238a62363bf994d20c966a0356c65e22d0838a9de08014fa239a906ed27b7ade","favicon":"https://res.cloudinary.com/postman/image/upload/v1660797293/team/wfjckxbqneyyqdfrpzls.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidocs.driv.in/view/metadata/UzBqoQbJ"}