Emisión de créditos

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Introducción

La monetización te brinda la flexibilidad para emitir créditos para desarrolladores.

En el caso de un desarrollador prepagado, un crédito aparece como una reducción en el uso, lo que 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 prepago de un desarrollador cuando este compra un paquete de productos de API. El desarrollador debe mantener un saldo adecuado para las compras. Consulta ¿Cómo calculo el saldo restante de la cuenta prepagada?

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

Explora la página Créditos

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

Cómo emitir 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	Es el mes de facturación en el que se aplica el crédito. Selecciona un mes de la lista.
   Desarrollador	Es el nombre del desarrollador o la empresa a la que se aplica el crédito. Ingresa el nombre en el cuadro de texto. A medida que escribes, se muestra en un menú desplegable una lista de los desarrolladores o las empresas que contienen la cadena. Haz clic en el nombre del desarrollador o la empresa en la lista desplegable. Nota: Después de seleccionar un desarrollador o una empresa, se muestran 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	Es el paquete de productos de API al que se aplica el crédito. Selecciona de la lista de paquetes de productos de API disponibles.
   Producto	Es el producto de API del paquete de productos de API seleccionado al que se aplica el crédito. Selecciona Todos los productos o un solo producto de API de la lista.
   Moneda	Es la moneda que se usa para el crédito. La moneda se configura para el plan de tarifas en el paquete de productos de 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 Save Credit.

Emisión de créditos con la API

Con la API, emite crédito a un desarrollador por un paquete de productos de API en su totalidad 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, envía 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 envíes la solicitud, debes especificar los siguientes parámetros de consulta:

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

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

• Es el mes de facturación al que se aplica el crédito. De forma predeterminada, este valor es el mes actual.
• Es el 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 aplica a todos los productos de API del paquete de productos de API.

Por ejemplo, la siguiente solicitud emite un crédito de USD 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 payment y al plan de tarifas payment_standard_plan:

Consulta Parámetros de consulta para la API de créditos para 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 ejemplo de extracto 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 de 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	Predeterminado	¿Obligatorio?
billingMonth	Es el mes de facturación para el que se aplica el crédito, como ABRIL.	N/A	No
billingYear	Es el año de facturación para el que se aplica el crédito, como 2018.	N/A	No
currencyId	Es la moneda que se usa para el crédito. La moneda se configura para el plan de tarifas en el paquete de productos de API que el desarrollador compró y no se puede cambiar.	N/A	Sí
developerId	Es el nombre del desarrollador o la empresa a la que se aplica el crédito.	N/A	Sí
productId	Es el producto de API al que se aplica el crédito. Si no especificas un ID de producto, el crédito se aplica a todos los productos de la API en el paquete de productos de la API.	N/A	No
transactionAmount	Es el importe del crédito (en la moneda especificada). Especifica un valor positivo o negativo. El valor no puede ser cero.	N/A	Sí
transactionNote	Nota que describe el motivo del crédito.	N/A	Sí