InVeloz

Contenido

api

Inicio Rápido

Inicio Rápido

Esta guía lo lleva paso a paso a través de la autenticación con la API y sus primeras solicitudes. Obtendrá un token, listará artículos y creará un nuevo artículo — todo desde la línea de comandos.

Requisitos Previos

Necesita: credenciales de API (client ID y secret), su URL base, y curl o PowerShell.

Paso 1: Obtener un Token

curl -X POST https://su-host/api/v1/Token \
  -d "grant_type=client_credentials" \
  -d "client_id=SU_CLIENT_ID" \
  -d "client_secret=SU_CLIENT_SECRET"
{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1Ni...",
  "token_type": "bearer",
  "expires_in": 14399
}

Guarde el access_token — inclúyalo en cada solicitud subsiguiente. Usuarios de PowerShell: consulte Autenticación para un equivalente con Invoke-RestMethod.

Paso 2: Listar Artículos

curl "https://su-host/api/v1/Item?page=1&pageSize=5" \
  -H "Authorization: Bearer SU_ACCESS_TOKEN"
{
  "value": [
    {
      "partNo": 1,
      "shortID": "BOLT-M8",
      "description": "Hex Bolt M8x30",
      "categoryID": 5,
      "unit": "EA"
    }
  ],
  "totalCount": 2340,
  "page": 1,
  "pageSize": 5,
  "pageCount": 468,
  "hasMore": true
}

Paso 3: Obtener un Artículo Individual

curl https://su-host/api/v1/Item/1 \
  -H "Authorization: Bearer SU_ACCESS_TOKEN"

La respuesta es el objeto completo del artículo — sin envoltorio de paginación.

Paso 4: Crear un Artículo

curl -X POST https://su-host/api/v1/Item \
  -H "Authorization: Bearer SU_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "shortID": "TEST-API-001",
    "description": "Created via API",
    "unit": "EA",
    "categoryID": 1
  }'
{
  "partNo": 2341,
  "shortID": "TEST-API-001",
  "description": "Created via API",
  "unit": "EA",
  "categoryID": 1,
  "active": true
}

Una respuesta 201 Created incluye el artículo completo con su partNo asignado.

Nota: Una respuesta 403 significa que sus credenciales no tienen acceso de escritura al maestro de artículos.

Siguientes Pasos

  • Autenticacion — ciclo de vida del token y seguridad
  • Paginacion — iteracion sobre conjuntos grandes de resultados
  • Errores — comprension de respuestas de error
  • Articulos — referencia completa del endpoint de articulos
  • Inventario — recibir, mover y despachar existencias

En esta página