Emisión de créditos

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

Introducción

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

Para un desarrollador de prepago, se el crédito aparece como una reducción en el uso, lo que aumenta o disminuye el saldo prepagado del desarrollador en el futuro. Muy similar mediante una tarjeta de débito, los fondos se retiran del saldo prepagado del desarrollador cuando el desarrollador compra un paquete de productos de API. El desarrollador debe mantener un saldo adecuado para compras. Consulta la sección ¿Cómo calculo el saldo prepagado restante de la cuenta?

En el caso de los desarrolladores con pospago, los créditos aparecen como una línea separada en una factura, lo que reduce el cargo en una factura.

Exploración de la página Créditos

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

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	Es el 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 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 una opción de la lista de paquetes de productos de API disponibles.
   Producto	Producto de API del paquete de productos de API seleccionado al que se aplica el crédito. Seleccionar 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 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	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

Mediante la API, otorgar crédito a un desarrollador para un paquete de productos de API en su totalidad en comparación con 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, donde {package_id} y {rate-plan_id} definen la la identificación del paquete de productos de API y el plan de tarifas al que se aplica el crédito, respectivamente.

Cuando envías la solicitud, debes especificar como parámetros de consulta:

• Es 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. El valor predeterminado es el actual mes.
• Es el año de facturación en el que se aplica el crédito. Este valor se establece de forma predeterminada en el año actual.
• Producto de API al que se aplica el crédito. Si no especificas un producto de API ID, 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 por 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 producto de API de payment y plan de tarifas de 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 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 usar con la API de créditos: