Emisión de créditos

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Introducción

La monetización te brinda la flexibilidad de emitir créditos de desarrollador.

Para un desarrollador prepagado, el crédito aparece como una reducción en el uso, es decir, aumenta o disminuye el saldo prepagado del desarrollador en el futuro. Al igual que cuando se usa una tarjeta de débito, los fondos se retiran del saldo prepagado del desarrollador cuando este compra un paquete de productos de API. El desarrollador debe mantener un saldo adecuado para las compras. Consulte ¿Cómo puedo calcular el saldo prepagado restante de una cuenta?

Para un desarrollador de pospago, el crédito aparece como una línea separada en una factura, lo que reduce el cargo.

Exploración de la página Créditos

Accede y explora la página Créditos, como se describe a continuación.

Conexión de integración

Para acceder a la página Créditos con la IU de Edge, sigue estos pasos:

  1. Accede a apigee.com/edge.
  2. Selecciona Publish > Monetization > Créditos en la barra de navegación izquierda.

Aparecerá la página Créditos.

Como se destaca en la figura, la página Créditos le permite hacer lo siguiente:

  • Visualiza la información resumida de todos los créditos, incluido el nombre del destinatario, el importe del crédito, la fecha y la hora en que el crédito entró en vigencia, el paquete de productos de la API y los productos de la API a los que se aplica el crédito, y cualquier nota agregada
  • Emitir un crédito
  • Buscar en la lista de créditos

Versión clásica de Edge (nube privada)

Para acceder a la página Créditos con la IU clásica de Edge, sigue estos pasos:

  1. Accede a http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración.
  2. Selecciona Monetización > Informes de monetización en la barra de navegación superior.

La página Créditos te permite hacer lo siguiente:

  • Visualiza la información resumida de todos los créditos, incluido el nombre del destinatario, el importe del crédito, la fecha y la hora en que el crédito entró en vigencia, el paquete de productos de la API y los productos de la API a los que se aplica el crédito, y cualquier nota agregada
  • Emitir un crédito
  • Buscar en la lista de créditos

Emisión de un crédito

  1. Accede a la página Créditos.
  2. Haz clic en + Crédito.
  3. Ingresa la siguiente información:
    Campo Descripción
    Mes de facturación

    Mes de facturación en el que se aplica el crédito. Selecciona un mes de la lista.

    Desarrollador

    Nombre del desarrollador o de la empresa a la que se aplica el crédito Ingresa el nombre en el cuadro de texto. A medida que escribas, aparecerá una lista de los desarrolladores o las empresas que contengan la cadena en un menú desplegable. Haz clic en el nombre del desarrollador o de la empresa en la lista desplegable.

    Nota: Después de seleccionar un desarrollador o una empresa, se mostrarán los campos restantes. Si seleccionas una empresa o un desarrollador que no aceptó un plan de tarifas, no podrás emitir un crédito.

    Paquete de productos

    Paquete de producto de la API al que se aplica el crédito. Selecciona una opción de la lista de paquetes de productos de API disponibles.

    Producto

    Producto de API en el paquete de productos de API seleccionado al que se aplica el crédito. Selecciona All products o un solo producto de API de la lista.

    Moneda

    Es la moneda utilizada para el crédito. La moneda se configura para el plan de tarifas en el paquete de productos de la API que el desarrollador compró y no se puede cambiar. Si hay varias monedas definidas en un plan de tarifas, puedes seleccionar una de ellas.

    Importe

    Es el importe del crédito (en la moneda especificada). Especifica un valor positivo o negativo. El valor no puede ser cero.

    Nota

    Nota opcional para describir el motivo del crédito.

  4. Haz clic en Guardar crédito.

Emitir créditos con la API

Con la API, emite crédito a un desarrollador por el paquete de productos de API en su conjunto o por el uso de un producto de API específico en un paquete de productos de API.

Para emitir un crédito con la API, emite una solicitud POST a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, en la que {package_id} y {rate-plan_id} definen la identificación del paquete de productos de la API y el plan de tarifas al que se aplica el crédito, respectivamente.

Cuando emites la solicitud, debes especificar como parámetros de consulta:

  • ID de desarrollador (dirección de correo electrónico) al que se aplica el crédito
  • Importe del crédito
  • Es la moneda utilizada para el crédito.
  • Nota que describe el motivo del crédito.

De manera opcional, puedes especificar los siguientes parámetros de consulta adicionales:

  • Mes de facturación al que se aplica el crédito El valor predeterminado es el mes actual.
  • Año de facturación al que se aplica el crédito El valor predeterminado es el año actual.
  • Producto de API al que se aplica el crédito. Si no especificas un ID de producto de API, el crédito se aplicará a todos los productos de API del paquete de productos de API.

Por ejemplo, la siguiente solicitud emite un crédito de $100 para el mes de facturación de abril de 2018 a un desarrollador identificado como dev1@myorg.com. El crédito se aplica al paquete de productos de la API de payment y al plan de tarifas de payment_standard_plan:

Consulta Parámetros de consulta para la API de créditos a fin de obtener una lista completa de los parámetros de consulta que puedes especificar en una solicitud de crédito.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

A continuación, se proporciona un extracto de ejemplo de la respuesta:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

Parámetros de consulta para la API de créditos

Los siguientes parámetros de consulta están disponibles para usarse con la API de créditos:

Nombre Descripción Predeterminada ¿Obligatorio?
billingMonth

Mes de facturación en el que se aplica el crédito, como ABRIL.

No disponible No
billingYear

Es el año de facturación en el que se aplica el crédito (por ejemplo, 2018).

No disponible No
currencyId

Es la moneda utilizada para el crédito. La moneda se configura para el plan de tarifas en el paquete de productos de la API que el desarrollador compró y no se puede cambiar.

No disponible
developerId

Nombre del desarrollador o de la empresa a la que se aplica el crédito

No disponible
productId

Producto de API al que se aplica el crédito. Si no especificas un ID del producto, el crédito se aplicará a todos los productos de la API del paquete de productos de la API.

No disponible No
transactionAmount

Es el importe del crédito (en la moneda especificada). Especifica un valor positivo o negativo. El valor no puede ser cero.

No disponible
transactionNote

Ten en cuenta que describe el motivo del crédito.

No disponible