Saltar al contenido principal

Arranque rápido

Tres llamadas y ya estás leyendo datos. Reemplazá TU_API_KEY por la credencial que te entregaron.

1. ¿Qué entidades tengo disponibles?​

curl -s -H "X-API-Key: TU_API_KEY" \
  'https://TU-HOST/synergy-server/jwt-odata-key/'
{
  "@odata.context": "https://TU-HOST/synergy-server/jwt-odata-key/$metadata",
  "value": [
    { "name": "o_customers", "kind": "EntitySet", "url": "o_customers", "title": "Clientes" },
    { "name": "o_cities",    "kind": "EntitySet", "url": "o_cities",    "title": "Localidades" }
  ]
}

Esta respuesta es la fuente de verdad: las entidades que ves dependen de lo que el administrador habilitó para tu cliente de integración. Esta página usa o_customers y o_cities como ejemplos; los nombres reales salen de acá.

2. ¿Cómo son esas entidades?​

curl -s -H "X-API-Key: TU_API_KEY" \
  'https://TU-HOST/synergy-server/jwt-odata-key/$metadata'
peligro

Comillas simples, no dobles. En bash, "...$metadata" hace que la shell reemplace $metadata por una variable vacía y la URL llega cortada. Usá siempre comillas simples alrededor de cualquier URL con $, o escapá cada $. Es el error número uno al probar con curl.

3. Primera página de datos​

curl -s -H "X-API-Key: TU_API_KEY" \
  'https://TU-HOST/synergy-server/jwt-odata-key/o_customers?$top=5&$count=true'
{
  "@odata.context": "https://TU-HOST/synergy-server/jwt-odata-key/$metadata#o_customers",
  "@odata.count": 1843,
  "value": [
    {
      "@odata.id": "https://TU-HOST/synergy-server/jwt-odata-key/o_customers('C0001')",
      "code": "C0001",
      "name": "Molinos del Sur SA",
      "city_code": "ROS",
      "Localidad@odata.navigationLink": "https://TU-HOST/synergy-server/jwt-odata-key/o_customers('C0001')/Localidad"
    }
  ],
  "@odata.nextLink": "https://TU-HOST/synergy-server/jwt-odata-key/o_customers?$count=true&$skiptoken=czo1"
}

Los @odata.navigationLink son el atajo para explorar: te dicen a qué maestro relacionado podés saltar sin tener que leer el $metadata primero.