Ir al contenido

Primera consulta

Usá la URL exacta del ambiente que te asignó el administrador. En los ejemplos, SERVER significa su origen HTTPS, sin /api al final. Los valores entre marcadores son ejemplos, no credenciales.

  1. El administrador crea una aplicación en Configuración → IAM → Aplicaciones externas (/admin/iam/external-client-apps).
  2. Habilita API habilitada en el perfil o permission set del usuario y le asigna permisos sobre los objetos y campos necesarios.
  3. Verifica la publicación del objeto en Objetos en API. Verlo en la interfaz no significa que esté publicado.
  4. Elegí OAuth por usuario o integración técnica. Para una prueba interactiva, usá la CLI.

Este ejemplo usa PowerShell 7. Cargá un access token válido en ERP_ACCESS_TOKEN mediante tu cliente OAuth, sin incluirlo en archivos del proyecto ni en mensajes a una IA.

Ventana de terminal
$server = $env:ERP_SERVER_URL.TrimEnd('/')
$headers = @{ Authorization = "Bearer $env:ERP_ACCESS_TOKEN" }
$identity = Invoke-RestMethod "$server/api/v1/identity" -Headers $headers
$identity
$objects = Invoke-RestMethod "$server/api/v1/objects" -Headers $headers
$objects.records | Select-Object apiName, label, capabilities

Comprobá el tenant y usuario devueltos por identity. Elegí un apiName de objects.records, sin traducirlo ni deducirlo del rótulo visible.

Ventana de terminal
$objectName = Read-Host 'Nombre API del objeto obtenido en la lista'
$objectPath = [uri]::EscapeDataString($objectName)
$describe = Invoke-RestMethod "$server/api/v1/objects/$objectPath/describe" -Headers $headers
$describe.fields | Select-Object apiName, fieldType, readable, editable
$page = Invoke-RestMethod "$server/api/v1/data/${objectPath}?take=5" -Headers $headers
$page.records

Un campo ausente puede estar oculto por permisos. Una lista vacía no autoriza a buscar por otra identidad ni demuestra que no existan registros fuera de tu acceso.

GET /api/v1/openapi.json, GET /api/v1/scopes, GET /api/v1/capabilities y /versions/6d4a5d351b6045099122f91e7a5400f4e0757d99/docs/ son públicos. Describen contratos; no publican los datos privados ni el esquema completo de un tenant. /objects, /describe y las consultas requieren autenticación.