POST

/session/device — Abrir sesión

Inicia una sesión asociada a una unidad de cobro. Devuelve el token que usarás en todas las llamadas siguientes.

Endpoint

https://api-integrationcheckout-uat.yappycloud.com/v1https://api-checkout.yappy.cloud/v1/session/device

Headers

HeaderValor
api-keyTu API Key
secret-keyTu Clave Secreta
Content-Typeapplication/json

Body

CampoTipoRequeridoDescripción
body.device.idstringsíNombre de la unidad de cobro (ej. sanfrancisco-01)
body.device.namestringnoNombre referencial de la caja.
body.device.userstringnoUsuario referencial del cajero.
body.group_idstringsíID del grupo (ej. sanfrancisco)

Body de ejemplo

{
  "body": {
    "device": {
      "id": "sanfrancisco-01",
      "name": "Caja-01",
      "user": "CAJERO-001"
    },
    "group_id": "sanfrancisco"
  }
}

Response 200 OK

{
  "status": {
    "code": "YP-0000",
    "description": "Se ha realizado la ejecución del servicio correctamente"
  },
  "body": {
    "status": "OPEN",
    "opened_date": "2026-05-15T08:00:00.000",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Llamada de ejemplo

curl -X POST "{{BASE_URL}}/session/device" \
  -H "api-key: $YAPPY_API_KEY" \
  -H "secret-key: $YAPPY_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "body": {
      "device": { "id": "sanfrancisco-01", "name": "Caja-01", "user": "CAJERO-001" },
      "group_id": "sanfrancisco"
    }
  }'

const resp = await fetch("{{BASE_URL}}/session/device", {
  method: "POST",
  headers: {
    "api-key": process.env.YAPPY_API_KEY,
    "secret-key": process.env.YAPPY_SECRET_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    body: {
      device: { id: "sanfrancisco-01", name: "Caja-01", user: "CAJERO-001" },
      group_id: "sanfrancisco"
    }
  })
});
const { body } = await resp.json();
const sessionToken = body.token;

import os, requests

resp = requests.post(
    "{{BASE_URL}}/session/device",
    headers={
        "api-key": os.environ["YAPPY_API_KEY"],
        "secret-key": os.environ["YAPPY_SECRET_KEY"],
        "Content-Type": "application/json"
    },
    json={
        "body": {
            "device": {"id": "sanfrancisco-01", "name": "Caja-01", "user": "CAJERO-001"},
            "group_id": "sanfrancisco"
        }
    }
)
session_token = resp.json()["body"]["token"]

<?php
$ch = curl_init("{{BASE_URL}}/session/device");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "api-key: " . getenv("YAPPY_API_KEY"),
  "secret-key: " . getenv("YAPPY_SECRET_KEY"),
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
  "body" => [
    "device" => ["id" => "sanfrancisco-01", "name" => "Caja-01", "user" => "CAJERO-001"],
    "group_id" => "sanfrancisco"
  ]
]));
$resp = json_decode(curl_exec($ch), true);
$sessionToken = $resp["body"]["token"];
Errores comunes
  • YP-0006: Error al abrir caja — revisa que el device.id esté creado en Yappy Comercial.
  • YP-0008: Cabeceras faltantes — verifica que envíes api-key y secret-key correctos.
  • YP-0009: Campos faltantes — revisa device.id y group_id.
¿Te fue útil esta página?