{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e986d7ad-b676-49fb-afeb-efa0d35c8bed","name":"Bus de Integraciones - v.21","description":"Bus de servicios para las integraciones, que ofrece distintas funcionalidades y servicios accesibles mediante su API REST, para que las integraciones hagan uso de ellos.\n\n## Servicios disponibles \n\n### Gestión de organizaciones\n\nCuenta con una gestión de los datos de las organizaciones que han activado la integración, encargándose de almacenar y gestionar los credenciales de acceso de cada organización, y la configuración necesaria para la integración. De forma que la integración puede consultar esos datos en cualquier momento de forma fácil.\n\n### Estados dinámicos\n\nOfrece un sistema para poder llevar el control de estados dinámicos que necesite la integración, tanto globales de la integración, o estados por organización.\n\n### Sistema de KV\n\nOfrece un sistema de clave-valor para que la integración persista los datos que necesite.\n\n### Sistema de queues\n\nOfrece un sistema de colas, permitiendo a la integración trabajar con tantas colas como necesite, de forma fácil. Este sistema de colas propio es la columna vertebral de toda la Plataforma de Integraciones.\n\n### Sistema de storage\n\nOfrece un sistema de storage, para poder almacenar los ficheros que se necesiten en el bus, garantizando que no se pierdan datos, y liberando a las integraciones de tener que contar con un almacenamiento propio.\n\n### Sistema de Boxes\n\nDistintos recursos y funciones para poder llevar la gestión de los mensjaes de las queues cuando se producen errores, de forma que una vez revisado y resuelto el problema se pueda volver a procesar. Lo que nos garantiza que nunca perdamos ningún mensaje.\n\n## Características de la API REST\n\nEsta API es navegable de forma que todas las representaciones contienen un atributo '_links_' con enlaces a los recursos recursos relacionados. Y siempre tendrán el enlace a su propio recurso (_self_).\n\n### Uso para integraciones\n\nTodos las request irán autenticadas con el header de autenticación de la integración. Una integración nunca podrá acceder a datos de otra integración.\n\n### Media-Types \n\nEl Bus cuenta con media-types propios para cada uno de los modelos de lógica de negocio. \n\nTodas las requests que lleven información en el body deberán indicar el media-type del mismo en la cabecera _Content-Type_. De la misma forma el Bus devuelve siempre la cabecerá _Content-Type_ en las respuestas, con el media-type del contenido de la respuesta.\n\n# Gestión de errores\n\nTodos los errores devueltos por la API del Bus van tipados con una información que permite poder identificar y automatizar el control de errores en función del tipado.\n\nPara ello en el modelo para la representación del error contamos con el atributo **typed_info**, que servirá para clasificar el error; y el atributo **data**, que contendrá los datos concretos que han producido el error.\n\n> **_Ejemplo_**:\nTenemos una organización con gestiona-id '1', e intentamos añadir otra con el mismo gestiona-ia. Esto provocará un error porque la organización está duplicada.\nEl error que nos devuelve la API llevará en **typed_info** la información para identificar que el error es de \"una organización duplicada\", y en **data** nos mostrará el valor duplicado, en este caso '1'.\nEn errores de _Not Found_ el campo data contendrá la información que identifica al entity que no se ha encontrado. El 'id' si es una integración; el 'store' y la 'key' si es una entrada de KV, etc.\n\n## Typed Info\n\nHay 4 campos que nos definen el tipado de un error.\n\n* `element`: \n    Identifica el elemento que ha producido el error. \n    \n* `action`:\n    Acción que se ha ejecutado sobre el elemento.\n    \n* `type`:\n    Clasificatión del tipo de error producido.\n    \n* `cause`: \n    Causa o sub-tipo del error.\n    \n### element\n\nLos elementos son los _entities_ principales del Bus. Es decir, integraciones, organizaciones, mensajes de queues, estados (por integración, o por organización), etc.\nTenemos un enumerado con todos los elementos disponibles en `gestiona.integrations.bus.models.api.BusErrorTypedInfo.Element`.\n\n### action\n\nLas distintas acciones que se pueden hacer con cada elemento, a traves de los recursos correspondientes. Hay acciones comunes a todos o casi todos los elementos, como _get_, _create_, etc; y luego tenemos acciones que son propias de cada elemento, como por ejemplo un _delay_ de un mensaje, un _merge_ de uploads, etc. \n\nAquí dejamos un posible enumerado de Java para gestiona más comodamente las distintas acciones.\n\n```java\n\n  /**\n   * Acciones posibles del Bus.\n   */\n  public enum Action {\n\n    /**\n     * Listar elementos. <br> Tipo de elemento: Genérico.\n     */\n    list,\n\n    /**\n     * Creación de un elemento. <br> Tipo de elemento: Genérico.\n     */\n    create,\n    /**\n     * Obtención de un elemento. <br> Tipo de elemento: Genérico.\n     */\n    get,\n    /**\n     * Actualización de un elemento. <br> Tipo de elemento: Genérico.\n     */\n    update,\n    /**\n     * Borrado de un elemento. <br> Tipo de elemento: Genérico.\n     */\n    delete,\n    /**\n     * Búsqueda de un elemento por distintos campos. <br> Tipo de elemento: Genérico.\n     */\n    search,\n\n    /**\n     * Borrado en transacción de un Qmessage con acciones extra. <br> Tipo de elemento: {@link Element#Qmessage}\n     */\n    deleteTX,\n    /**\n     * Reserva durante un tiempo de un Qmessage. <br> Tipo de elemento: {@link Element#Qmessage}\n     */\n    hold,\n    /**\n     * Reserva hasta un fecha de un Qmessage. <br> Tipo de elemento: {@link Element#Qmessage}\n     */\n    delay,\n    /**\n     * Congelación de un Qmessage. <br> Tipo de elemento: {@link Element#Qmessage}\n     */\n    frozen,\n    /**\n     * Forzado la disponibilidad de un Qmessage. <br> Tipo de elemento: {@link Element#Qmessage}\n     */\n    available,\n\n    /**\n     * Merge de ficheros temporales. <br> Tipo de elemento: {@link Element#Upload}\n     */\n    merge,\n\n    /**\n     * Validación de una Organización. <br> Tipo de elemento: {@link Element#Organization}.\n     */\n    validation,\n\n    /**\n     * Revocación de una Organización. <br> Tipo de elemento: {@link Element#Organization}.\n     */\n    revocation\n\n  }\n\n```\n\n### type\n\nPara identificar los errores agruparemos los errores en distintos tipos generales, como _autenticación_, _persistencia_, _validación_, etc. \n\nAquí dejamos un posible enumerado de Java para gestiona más comodamente las distintas acciones.\n\n```java\n\n  /**\n   * Tipos de errores que se pueden dar según el origen del proceso en el que se producen.\n   */\n  public enum Type {\n    /**\n     * Proceso de autenticación de las requests.\n     */\n    authentication,\n    /**\n     * Proceso de validación de los datos enviados en las requests.\n     */\n    validation,\n    /**\n     * Gestión de la persistencia (guardado y/o obtención) de los datos de las requests.\n     */\n    persistence,\n    /**\n     * Proceso de validación de acciones según la lógica de negocio.\n     */\n    forbidden,\n    /**\n     * Subtareas dentro de la acción (acciones extra).\n     */\n    subTask,\n    /**\n     * Errores internos del Bus, que no son controlados.\n     */\n    internal\n  }\n\n```\n\n### cause\n\nPara cada tipo de error, tendremos una causa que servirá para concretar más el error que se ha producido. A continuación se detallan las causas principales para cada tipo de error.\n\n* **`authentication`**:\n    integration required, bad integration, bad administrator, bad auth, access-key required, admin-key required, auth required.\n\n* **`validation`**:\n    Content required, conflict (inconsistencia de datos enviados), header required, unsupported media type, bad syntax, checksum, temporal not exists, data (para las validaciones del conjunto de datos enviado)\n\n* **`persistence`**:\n    not found, duplicate, stale object, message-stolen.\n    \n* **`subTask`**:\n    Este tipo de error se produce en las acciones que llevan tareas extra en transacción, y es una de esas tareas extra la que ha provocado el error. Por lo que la causa siempre será `suberror`, y en los datos contendrá el *typed_info* y _data_ del suberror.\n\n* **`internal`**:\n    Este se usa para errores desconocidos y/o no controlados que se producen internamente en el Bus, por lo que la causa siempre será `unknow`.\n\n## Data\n\nAquí tendremos todos los atributos/campos que nos sirvan para identificar los datos que han provocado el error. Dependiendo del elemento, y del tipo de error los datos a mostrar variarán. \n\nPor norma general, se mostrará siempre el `id`, y/o los campos de la `uk` del elemento que ha provocado el error. Si son errores a nivel general de request, como por ejemplo que falte un header obligatorio, en data tendremos el nombre del header que ha provocado el error.\nEn el caso de los `subTask|sub-error`, en el data siempre tendremos la información del suberror, es decir, un atributo `typed_info` con el tipado del suberror, y un atributo `data` con la información.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"487482","team":68092,"collectionId":"e986d7ad-b676-49fb-afeb-efa0d35c8bed","publishedId":"S11Ex1Kw","public":true,"publicUrl":"https://bus-integrations.doc.g3stiona.com","privateUrl":"https://go.postman.co/documentation/487482-e986d7ad-b676-49fb-afeb-efa0d35c8bed","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-08-21T10:53:16.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Documentación-ARANAZ","id":"825e9309-75f4-ae6e-8d9e-3da5151ac086","owner":"487482","values":[{"enabled":true,"key":"ges-02","value":"https://02.g3stiona.com/rest/","type":"text"},{"enabled":true,"key":"sample-bus","value":"http://bus:8086/v1","type":"text"},{"enabled":true,"key":"bus","value":"{{local-bus}}","type":"text"},{"enabled":true,"key":"gestiona","value":"{{g3s-02}}","type":"text"},{"enabled":true,"key":"gestiona-org-id","value":"1234dtbe-1581-4249-9345-9044054c5449","type":"text"},{"enabled":true,"key":"organization-id","value":"7e2d6c0e-5957-417c-b7c8-4022fe63d287","type":"text"},{"enabled":true,"key":"access-key","value":"_sample6","type":"text"},{"enabled":true,"key":"admin-key","value":"synchro-key","type":"text"},{"enabled":true,"key":"integration-id","value":"f128de3f-f5bf-317e-a40d-7ee38877a351","type":"text"},{"enabled":true,"key":"addon","value":"_mir4","type":"text"},{"enabled":true,"key":"addon-code","value":"sample","type":"text"},{"enabled":true,"key":"msg-id","value":"21f90078-c196-3592-a63e-ed6216c9bb99","type":"text"},{"enabled":true,"key":"access-token","value":"_OxN1W8EafWkZbb0Gyr2shQ__7","type":"text"},{"enabled":true,"key":"event-id","value":"00000vkpy49j7j56elgoe9af97us0wbqr42cov11m3r43lzag3%23file-created","type":"text"},{"enabled":true,"key":"upload-link","value":"http://bus:8086/v1/uploads/00000vlp2nn2n0b45ov5sf52wi1vvi3opqcuxj63wmp8ttc7ja","type":"text"},{"enabled":true,"key":"queue","value":"PRUEBA1","type":"text"},{"enabled":true,"key":"search-tag","value":"sample-searchable","type":"text"},{"enabled":true,"key":"tag-value","value":"code-02","type":"text"},{"enabled":true,"key":"kv-store","value":"mi/store","type":"text"},{"enabled":true,"key":"kv-key","value":"123","type":"text"},{"enabled":true,"key":"kv-value","value":"code-123","type":"text"},{"enabled":true,"key":"entity-version","value":"2","type":"text"},{"enabled":true,"key":"date","value":"1510516620","type":"text"},{"enabled":true,"key":"state","value":"process%252Flist","type":"text"},{"enabled":true,"key":"sha512","value":"aac49c16add3538e100ae79a9f41df6975c4dadffd3df11be280f4bf00f411e44207bdac82b576018b3068531d5344b8c18758bcc0c97fe9fb92c9ad237e1b2b","type":"text"},{"enabled":true,"key":"upload-chunk-1","value":"{{upload-link}}","type":"text"},{"enabled":true,"key":"upload-chunk-2","value":"{{upload-link}}","type":"text"},{"enabled":true,"key":"storage-key","value":"mir","type":"text"},{"enabled":true,"key":"full-queue-message","value":"{\n        \"queue_code\": \"PRUEBA1\",\n        \"payload\": \"mensjae de ejemplo\",\n        \"organization_id\": \"155a7265-e60d-4893-88e4-bd8fbb008883\",\n        \"failed_deliveries\": \"0\",\n        \"version\": \"5\",\n        \"id\": \"0\",\n        \"links\": {\n            \"self\": \"http://bus:8086/v1/queues/PRUEBA1/0\"\n        }\n    }","type":"text"},{"enabled":true,"key":"luis","value":"holiii","type":"text"}],"published":true}],"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/893e4c8ae20ed74905832350a8d12bf04599922fb75b7fb068284fc3bd665cf6","favicon":"https://res.cloudinary.com/postman/image/upload/v1566384383/team/dret5wwtn5psib4yztvd.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"},{"label":"Documentación-ARANAZ","value":"487482-825e9309-75f4-ae6e-8d9e-3da5151ac086"}],"canonicalUrl":"https://bus-integrations.doc.g3stiona.com/view/metadata/S11Ex1Kw"}