Árbol del API · Guías › Primeros pasos
Primeros pasos
5 min
Tu primera consulta al API de AdvantaCloud con una Llave API, de la llave a la respuesta.
El API de AdvantaCloud es un solo endpoint GraphQL. Con una Llave API tu integración lee y registra información de tu empresa con las mismas reglas que la aplicación: pides exactamente los campos que necesitas y recibes JSON.
1. Apunta al subdominio de tu empresa
Cada empresa tiene su propio subdominio, y es el subdominio el que elige la empresa de cada petición. Escríbelo aquí y todos los ejemplos del sitio lo usarán (se guarda sólo en tu navegador):
https://mi-empresa.advantacloud.com/graphql2. Guarda tu Llave API
Para este ejemplo la llave necesita el permiso «Ventas». Guárdala en una variable de entorno:
export ADVANTA_API_KEY="pega-aquí-tu-llave"
3. Envía tu primera consulta
Pide tus tres órdenes de venta más recientes:
curl https://mi-empresa.advantacloud.com/graphql \
-H "Authorization: Bearer $ADVANTA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query": "{ ordersConnection(first: 3) { nodes { folio status total } } }"}'La respuesta trae sólo los campos que pediste:
{
"data": {
"ordersConnection": {
"nodes": [
{ "folio": "OV00512", "status": "CONFIRMED", "total": "4872.00" },
{ "folio": "OV00511", "status": "REGISTERED", "total": "18560.00" },
{ "folio": "OV00510", "status": "SOLD", "total": "2349.48" }
]
}
}
}Los montos llegan como texto decimal ("4872.00"), nunca como número
flotante.
Si recibes HTTP 401, revisa la llave y el subdominio. Si
nodesllega vacío y sabes que hay órdenes, la llave no tiene el permiso «Ventas»: el API responde así, sin error, para no romper integraciones que ya existen.
Siguientes pasos
- Autenticación con Llave API: permisos, alcance y cuidado de la llave.
- Paginación con cursores: cómo traer listas completas.
- Errores y reintentos: qué revisar en cada respuesta.
- Referencia de Pedidos: consultar, cotizar, crear y cancelar órdenes de venta.