Información General

Esta página te ayudará a comenzar con el API de Alegra

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.

Algunas aplicaciones que puedes construir con nuestra API son:

  • Sincronizar de manera automática tus contactos con Alegra y otra aplicación externa que utilices.
  • Crear automáticamente facturas en la aplicación a partir de pedidos de tu página web.
  • Sincronizar tus productos o servicios con Alegra.

Nuestra API está basada en principios REST que harán más fácil tu conexión y desarrollo; métodos HTTP (GET, POST, PUT y PATCH) 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.

{
  "id": 1,
  "name": "Billetera",
  "description": "Billetera de cuero negro",
  "reference": "REF-005",
  "inventory": {
    "unit" : "piece",
    "availableQuantity" : 150,
    "unitCost" : 560,
    "initialQuantity" : 320
  },
  "tax" : [
    {
      "id" : 6,
      "name" : "IVA",
      "percentage" : 19,
      "description" : "Impuesto de valor agregado"
    }
    ],
    "category" : {
      "id": 54,
      "name" : "Ventas"
    },
    "price" : [
      {
        "idPriceList" : 1,
        "name" : "General",
        "price" : 1200
      },
      {
        "idPriceList" : 2,
        "name" : "Distribuidor",
        "price" : 1050
      }
  ]                
}
{
  "code" : "901",
  "message" : "Esta acción no está permitida para el usuario actual."
}

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.

📘

Toda la comunicación con el API debe hacerse utilizando https://

PRUEBAS EN VIVO

En nuestra documentación encontrarás un explorador de API que te permite realizar requests a tu cuenta y descubrir cómo funciona.

📘

Ten en cuenta que los request que realices pueden modificar la información de tu cuenta.

Para utilizar el API explorer debes utilizar tu correo y token de acceso.


Siguiente paso

Antes de comenzar te recomendamos los siguientes documentos que pueden ser de ayuda: