{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Información general","type":"basic","slug":"empiezar-con-api-alegra","excerpt":"Esta página te ayudará a comenzar con el API de Alegra","body":"El API de Alegra es un servicio que te permite acceder a tu cuenta para mantener tu información actualizada, conectar aplicaciones externas y tener acceso instantáneo a tus datos. \n\nAlgunas aplicaciones que puedes construir con nuestra API son:\n\n * Sincronizar de manera automática tus contactos con Alegra y otra aplicación externa que utilices.\n * Crear automáticamente facturas en la aplicación a partir de pedidos de tu página web.\n * Sincronizar tus productos o servicios con Alegra.\n\nActualmente nuestra API puedes\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Recurso\",\n \"h-1\": \"Endpoint\",\n \"h-2\": \"Descripción\",\n \"0-0\": \"Productos o servicios\",\n \"0-1\": \"/items\",\n \"0-2\": \"Consultar uno o todos los productos/servicios registrados en la aplicación. También puedes crear un producto nuevo.\",\n \"1-0\": \"Contactos\",\n \"2-0\": \"Facturas de venta\",\n \"3-0\": \"Numeración de factura\",\n \"4-0\": \"Impuestos\",\n \"5-0\": \"Cuentas de banco\",\n \"6-0\": \"Empresa\",\n \"7-0\": \"Pagos\",\n \"8-0\": \"Categorías\",\n \"1-2\": \"Consultar uno o todos los contactos (clientes/proveedores) registrados. También puedes crear un contacto nuevo.\",\n \"2-2\": \"Consultar una o todas las facturas de venta, crear una nueva o enviar una factura por correo.\",\n \"3-2\": \"Permite consultar las numeraciones para facturación que tiene configurada la empresa.\",\n \"4-2\": \"Permite consultar los impuestos de la compañía.\",\n \"5-2\": \"Permite consultar las cuentas de banco que tiene registrada la compañía en la aplicación.\",\n \"6-2\": \"Indica la información de la empresa como el nombre, dirección, régimen, entre otros.\",\n \"7-2\": \"Permite consultar los pagos que se tienen registrados en la aplicación. También se puede realizar pagos a facturas de venta, facturas de compra o categorías\",\n \"8-2\": \"Permite consultar las categorías configuradas en la aplicación.\",\n \"1-1\": \"/contacts\",\n \"2-1\": \"/invoices\",\n \"3-1\": \"/number-templates\",\n \"4-1\": \"/taxes\",\n \"5-1\": \"/bank-accounts\",\n \"6-1\": \"/company\",\n \"7-1\": \"/payments\",\n \"8-1\": \"/categories\",\n \"9-0\": \"Ajustes de categorías\",\n \"9-1\": \"/journals\",\n \"9-2\": \"Permite consultar uno o todos los ajustes de categorías registrados en la aplicación, crear uno nuevo, editarlos y eliminarlos.\",\n \"10-0\": \"Monedas\",\n \"10-1\": \"/currencies\",\n \"10-2\": \"Permite consultar una o todas las monedas asociadas a una cuenta.\"\n },\n \"cols\": 3,\n \"rows\": 11\n}\n[/block]\n\nNuestra API está basada en principios REST que harán más fácil tu conexión y desarrollo; métodos HTTP (GET y POST) son utilizados para acceder a los recursos. El sistema procesa el request y retorna un código de respuesta en un formato de fácil compresión.\n\n###Ejemplos\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"id\\\": 1,\\n \\\"name\\\": \\\"Billetera\\\",\\n \\\"description\\\": \\\"Billetera de cuero negro\\\",\\n \\\"reference\\\": \\\"REF-005\\\",\\n \\\"inventory\\\": {\\n \\\"unit\\\" : \\\"piece\\\",\\n \\\"availableQuantity\\\" : 150,\\n \\\"unitCost\\\" : 560,\\n \\\"initialQuantity\\\" : 320\\n },\\n \\\"tax\\\" : [\\n {\\n \\\"id\\\" : 6,\\n \\\"name\\\" : \\\"IVA\\\",\\n \\\"percentage\\\" : 16,\\n \\\"description\\\" : \\\"Impuesto de valor agregado\\\"\\n }\\n ],\\n \\\"category\\\" : {\\n \\\"id\\\": 54,\\n \\\"name\\\" : \\\"Ventas\\\"\\n },\\n \\\"price\\\" : [\\n {\\n \\\"idPriceList\\\" : 1,\\n \\\"name\\\" : \\\"General\\\",\\n \\\"price\\\" : 1200\\n },\\n {\\n \\\"idPriceList\\\" : 2,\\n \\\"name\\\" : \\\"Distribuidor\\\",\\n \\\"price\\\" : 1050\\n }\\n ]\\n \\n}\",\n \"language\": \"json\",\n \"name\": \"Respuesta exitosa (Código HTTP 200) \"\n },\n {\n \"code\": \"{\\n\\\"code\\\" : \\\"901\\\",\\n\\\"message\\\" : \\\"Esta acción no está permitida para el usuario actual.\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Respuesta error (Código HTTP 403)\"\n }\n ]\n}\n[/block]\n**El formato de transferencia de datos soportado por la aplicación es JSON. Todas las respuestas se envían en formato JSON y así espera recibirlos.** \n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Toda la comunicación con el API debe hacerse utilizando https://\"\n}\n[/block]\n## Códigos de respuesta HTTP\n\nEl API puede retornar alguno de los siguientes códigos HTTP:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Código\",\n \"h-1\": \"Descripción\",\n \"0-0\": \"400\",\n \"0-1\": \"El request está mal formado. La información para crear el recurso no existe o es inválida.\",\n \"1-0\": \"401\",\n \"1-1\": \"Error en autenticación. La autenticación fallo o no se encontró la información para autenticar el request.\",\n \"3-0\": \"403\",\n \"3-1\": \"El usuario no tiene permisos para realizar la acción.\",\n \"4-0\": \"404\",\n \"5-0\": \"405\",\n \"6-0\": \"201\",\n \"7-0\": \"200\",\n \"8-0\": \"500\",\n \"4-1\": \"No se encontró en la aplicación el recurso que se está buscando. También se retorna cuando la cuenta se encuentra suspendida.\",\n \"5-1\": \"Operación no permitida. Ocurre cuando el método del request es inválido para el endpoint requerido.\",\n \"6-1\": \"El recurso se creó exitosamente.\",\n \"7-1\": \"Todo funcionó correctamente.\",\n \"8-1\": \"Ocurrió un error en la aplicación.\",\n \"2-0\": \"402\",\n \"2-1\": \"Pago requerido. La acción no se pudo realizar exitosamente ya que la cuenta se encuentra suspendida o el plan actual de la compañía no permite realizar la acción.\",\n \"9-0\": \"503\",\n \"9-1\": \"Servicio no disponible. Eje: Modo mantenimiento de la aplicación.\"\n },\n \"cols\": 2,\n \"rows\": 10\n}\n[/block]\n##Pruebas en vivo\nEn nuestra documentación encontrarás un explorador de API que te permite realizar requests a tu cuenta y descubrir cómo funciona.\n[block:callout]\n{\n \"type\": \"warning\",\n \"title\": \"Debes tener en cuenta que los request que realices pueden modificar la información de tu cuenta.\",\n \"body\": \"Para utilizar el API explorer debes utilizar tu correo y [token de acceso](/docs/limite-request).\"\n}\n[/block]\n## Lecturas recomendadas\nAntes de comenzar te recomendamos los siguientes documentos que pueden ser de ayuda:\n\n[Autenticación](doc:autenticacion) \n[Limite request](doc:limite-request)","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56af82fd5b1f01170014dbd6","__v":65,"createdAt":"2016-02-01T16:08:29.126Z","category":{"sync":{"isSync":false,"url":""},"pages":["56abd2454e4b730d009eb110","56af82fd5b1f01170014dbd6","56b276461bc8490d00701fc9","56b279f73b6f690d00bdb76a","56b4bc4999c8d30d00f557f1","56b4bdf95997532100bc6b70","56b50972eed075230097d71a","56b520525f1cf00d00cc4737","56c34084521f350d00d34864"],"title":"Documentación","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"56abd2444e4b730d009eb10e","version":"56abd2434e4b730d009eb10d","__v":9,"createdAt":"2016-01-29T20:57:40.302Z","project":"56abd2434e4b730d009eb10a"},"project":"56abd2434e4b730d009eb10a","user":"56abd213d4432d1900eed227","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22","5fc1133c51c8370081b28e2a"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":44,"createdAt":"2016-01-29T20:57:39.712Z"},"githubsync":"","parentDoc":null}
Información general
Esta página te ayudará a comenzar con el API de Alegra