Peiperless API
    Peiperless API
    • Bienvenido
    • Guía de inicio rápido
    • Tokens
      • Listar Tokens
        GET
      • Crear Token
        POST
      • Eliminar Token
        DELETE
    • Usuarios
      • Listar Usuarios
        GET
      • Obtener Usuario
        GET
      • Crear Usuario
        POST
      • Actualizar Usuario
        PUT
      • Eliminar Usuario
        DELETE
    • Empresas
      • Listar Empresas
        GET
      • Obtener Empresa
        GET
      • Crear Empresa
        POST
      • Actualizar Empresa
        PUT
      • Eliminar Empresa
        DELETE
    • Catálogos
      • Obtener Catálogo por su Slug
        GET
      • Listar Catálogos
        GET
      • Obtener Catálogo
        GET
      • Crear Catálogo
        POST
      • Actualizar Catálogo
        PUT
      • Eliminar Catálogo
        DELETE
      • Listar Vendedores asociados
        GET
      • Listar Visitantes asociados
        GET
    • Productos
      • Listar Productos
        GET
      • Obtener Producto
        GET
      • Crear Producto
        POST
      • Actualizar Producto
        PUT
      • Eliminar Producto
        DELETE
    • Vendedores
      • Listar Vendedores
      • Obtener Vendedor
      • Crear Vendedores
      • Actualizar Vendedor
      • Eliminar Vendedor
      • Listar Catálogos del Vendedor
      • Asociar Catálogo a Vendedor
      • Desasociar Catálogo de Vendedor
    • Visitantes
      • Listar Visitantes
      • Obtener Visitante
      • Crear Visitantes
      • Actualizar Visitantes
      • Eliminar Visitante
      • Listar Catálogos del Visitante
      • Asociar Catálogo a Visitante
      • Desasociar Catálogo de Visitante
    • Ordenes
      • Listar Órdenes
      • Obtener Orden

    Bienvenido

    Peiperless API#

    Bienvenido a la documentación oficial de la API REST de Peiperless, una plataforma moderna para la gestión de catálogos digitales, empresas, usuarios y órdenes.
    Nuestra API está diseñada para ser segura, flexible y fácil de usar por desarrolladores, permitiéndote automatizar flujos de trabajo e integrar Peiperless fácilmente con tus sistemas existentes.

    🔐 Autenticación#

    Todos los endpoints requieren autenticación mediante token Bearer.

    ¿Cómo obtener tu token?#

    1.
    Iniciá sesión en https://app.peiperless.com
    2.
    Accedé a tu Perfil de Usuario
    3.
    Ingresá a la sección “Access Tokens”
    4.
    Generá un nuevo token de API y copialo
    💡 Guardá tu token en un lugar seguro — lo necesitarás para cada solicitud.

    Encabezado de ejemplo#


    📚 Estructura de la API#

    La API sigue principios RESTful y está organizada por recursos:
    RecursoDescripción
    TokensGeneración y gestión de tokens de API
    UsuariosAlta, edición y eliminación de usuarios
    EmpresasAdministración de entidades comerciales
    CatálogosCreación y mantenimiento de catálogos de productos
    ProductosManejo de artículos, precios, stock e imágenes
    ÓrdenesProcesamiento y seguimiento de órdenes
    Vendedores/VisitantesGestión de acceso a catálogos por rol

    📦 Ejemplo de Request#

    Obtener listado de catálogos#

    Respuesta esperada:
    {
      "success": true,
      "data": [
        {
          "id": 1,
          "name": "Catálogo de Verano",
          "slug": "verano",
          "company_id": 123
        }
      ]
    }

    🚦 Códigos de respuesta#

    CódigoSignificado
    200OK
    201Recurso creado
    400Solicitud inválida
    401No autorizado (falta el token)
    403Prohibido (sin permisos)
    404Recurso no encontrado
    500Error interno del servidor

    🧑‍💻 Casos de uso comunes#

    Automatizar la creación de catálogos por empresa
    Sincronizar productos desde ERP u otros sistemas
    Consultar y gestionar información de órdenes
    Asignar/restringir acceso a catálogos por usuario

    🛟 Soporte#

    ¿Necesitás ayuda?
    📬 Contacto: soporte@peiperless.com

    ¡Construyamos algo increíble con Peiperless! 🚀
    Modified at 2025-04-14 16:57:35
    Next
    Guía de inicio rápido
    Built with