SMSPVAdevelopers
Private Email Rental
SMSPVA / DOCUMENTATION

Coste de restauración

GET /api/rent_email.php?method=calc_restore_order

SMSPVA API
GEThttps://smspva.com/api/rent_email.php?method=calc_restore_order

Envía una solicitud GET y comprueba status incluso con HTTP 200: 1 indica éxito, 0 fallo y 2 que no había buzones al crear el alquiler. Consulta los detalles en msg, errormsg y errorid.

Autenticación

Envía apikey como parámetro obligatorio de consulta.

Parámetros

NombreUbicaciónTipoObligatorioEjemploDescripción
apikeyquerystringSíSMSPVA_API_KEYClave API de la cuenta. Para leer mensajes o gestionar un alquiler, usa la clave de su propietario.
methodquerystringSí"calc_restore_order"Método que se va a ejecutar.
orderidqueryintegerSí123456ID de Create Order, Active Orders o Archived Orders, según el método que vayas a usar.

Cómo usar este método

Consulta el coste actual de restaurar un pedido de Pedidos archivados. data es un valor numérico en USD.

Esta consulta no restaura el alquiler ni cobra. Como el precio puede cambiar, hazla justo antes de Restaurar alquiler.

Ejemplos de solicitud

Entorno y dependencias. Los ejemplos codifican los parámetros y esperan hasta 30 segundos. Comprueba HTTP y status antes de usar data. cURL muestra el JSON para que lo revises; Java usa Jackson para leerlo.

  • SMSPVA_EMAIL_ORDER_ID: orderid.
: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
: "${SMSPVA_EMAIL_ORDER_ID:?Set SMSPVA_EMAIL_ORDER_ID}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent_email.php" \
  --data-urlencode "method=calc_restore_order" \
  --data-urlencode "apikey=$SMSPVA_API_KEY" \
  --data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID"

Respuestas

Consulta la respuesta correspondiente a tu solicitud. Los valores y las fechas son orientativos. Los campos opcionales pueden variar según el resultado o el formato elegido.

HTTP 200

Comprueba status aunque HTTP sea 200. Los valores de los ejemplos son orientativos.

application/json

Ejemplo de respuesta correcta

{
  "status": 1,
  "data": 0.7
}

Error

{
  "status": 0,
  "msg": "Incorrect apikey"
}

Correcto

NombreTipoDescripción
statusinteger(enum: [1])
datanumberCoste actual de restauración en USD.

Obligatorios: status, data

Error

Algunos errores incluyen errorid y errormsg; otros solo msg. Comprueba todos los campos presentes.

NombreTipoDescripción
statusinteger(enum: [0])
erroridintegerCódigo numérico de error, si se incluye.
errormsgstringDescripción del error, si se incluye.
msgstringMensaje de error.

Guías relacionadas

En esta página