Administra el perfil de la organización

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

En las siguientes secciones, se presenta el perfil de la organización y se describe cómo puedes administrarlo con la IU y la API.

Acerca del perfil de la organización

Como parte de la configuración inicial de la monetización, el equipo de configuración de Apigee Edge establece el perfil de tu organización.

Debes editar el perfil de la organización para agregar o actualizar la información sobre tu organización, según corresponda. Por ejemplo, es posible que debas actualizar el tipo de facturación, la configuración de la moneda o el modelo impositivo.

Configura la información básica sobre tu organización, incluida la siguiente:

  • Nombre, dirección y país de operación de la organización
  • Tipo de facturación (prepago, pospago o ambos), como se describe en Comprende el tipo de facturación
  • Ciclo de facturación (prorrateado o mes calendario)
  • Moneda base
  • Modelo fiscal que utiliza tu organización

Puedes administrar el perfil de tu organización con la IU y la API, como se describe en las siguientes secciones.

Explora la página de perfil de la organización

Accede a la página Perfil de la organización, como se describe a continuación.

Edge

Para acceder a la página Perfil de la organización con la IU de Edge, haz lo siguiente:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Monetización > Perfil de la organización en la barra de navegación izquierda.

Se muestra la página Perfil de la organización.

Como se destaca en la figura, la página de perfil de la organización te permite hacer lo siguiente:

  • Consulta la configuración actual del perfil de la organización
  • Editar la configuración del perfil de la organización, lo que incluye lo siguiente:

Classic Edge (nube privada)

Para acceder a la página Perfil de la organización con la IU de Classic Edge, haz lo siguiente:

  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. En la barra de navegación superior, selecciona Administrador > Perfil de la organización.

Se muestra la página Perfil de la organización.

La página Perfil de la organización te permite hacer lo siguiente:

  • Consulta la configuración actual del perfil de la organización
  • Editar la configuración del perfil de la organización, lo que incluye lo siguiente:

Edita el perfil de la organización con la IU

Para editar el perfil de la organización con la IU, haz lo siguiente:

  1. Accede a la página de perfil de la organización.
  2. Haz clic en Editar.
  3. En Nombre e información, edita el nombre de la organización y el país de operación.
  4. En Impuestos y moneda, edita los siguientes campos:
    Campo Descripción
    Modelo impositivo

    Nota: Solo se aplica si configuras planes de tarifas con porcentaje de ingresos y deseas generar documentos de facturación.

    Es el modelo fiscal para los planes de tarifas de reparto de ingresos que identifica el tipo de documentos de facturación requeridos.

    Estos son algunos de los valores válidos:

    • Divulgado: El proveedor de la API actúa como agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) que se recaudan del usuario final se transfieren al desarrollador. La comisión del proveedor de la API se recauda del desarrollador en forma de una factura de comisión. El proveedor de la API no se encarga del impuesto sobre las ventas que se recauda del usuario final, y es responsabilidad del desarrollador informar el impuesto sobre las ventas.
    • No divulgado: El proveedor de la API actúa como agente no divulgado del desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga a las autoridades fiscales locales. El desarrollador factura al proveedor de la API por el porcentaje de ingresos netos que le corresponde (menos los impuestos sobre las ventas y la comisión del proveedor de la API).
    • Híbrido: El proveedor de la API actúa como agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas que se recauda de sus suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API le pasa los ingresos restantes al desarrollador y, luego, le factura los cargos por comisión.
    Moneda

    Son las monedas que admite tu organización. En el caso de los planes de reparto de ingresos, hojas de tarifas y solo comisiones, se usa la moneda predeterminada para tu plan de tarifas. Cuando creas una tarjeta de tarifas o un plan solo de comisiones, puedes seleccionar la moneda que deseas usar en una lista de monedas admitidas. De manera opcional, puedes establecer el importe mínimo de recarga que los desarrolladores de apps pueden agregar al saldo de su cuenta prepagada para cada moneda.

    Para agregar una moneda, sigue estos pasos:

    1. Haz clic en Agregar moneda.
    2. Selecciona una moneda en el menú desplegable del campo Moneda.
    3. De manera opcional, establece el importe mínimo que los desarrolladores de apps pueden agregar al saldo de cuenta de su cuenta prepagada en la moneda especificada en el campo Recarga mínima.
    4. Haz clic en Agregar.
    5. Si lo deseas, haz clic en el botón de selección asociado para establecerla como la moneda predeterminada.
    6. Repite los pasos para agregar más monedas.

    Para borrar una moneda, coloca el cursor sobre la moneda que deseas borrar y haz clic en .
  5. Administra los términos y condiciones, como se describe en Cómo administrar los términos y condiciones con la IU.
  6. Haz clic en Guardar.

Administra el perfil de la organización con la API

Administra el perfil de la organización con la API, como se describe en las siguientes secciones.

Visualiza el perfil de la organización con la API

Para ver el perfil de tu organización, envía una solicitud GET a /mint/organizations/{org_name}. Por ejemplo:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Accept: application/json" \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta. Para obtener más información sobre las opciones que se muestran, consulta Propiedades de configuración del perfil de la organización para la API.

{
    "address" : [ {
      "address1" : "Test address”,
      "city" : "Test City",
      "country" : "US",
      "id" : "test-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "{org_name}"
    "issueNettingStmt" : false,
    "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "myorg",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : true,
    "status" : "ACTIVE",
    "supportedBillingType" : "PREPAID",
    "taxModel" : "UNDISCLOSED",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
}

Edita el perfil de la organización con la API

Edita el perfil de la organización enviando una solicitud PUT a /mint/organizations/{org_name}. Cuando edites el perfil de la organización, deberás especificar todas las propiedades del perfil, no solo las que estés editando.

Para editar la moneda predeterminada de la organización, establece el valor de currency en el código de moneda ISO 4217 de la moneda admitida que deseas establecer como predeterminada.

Por ejemplo, la siguiente llamada a la API actualiza el campo currency a USD y el parámetro de configuración del modelo impositivo a HYBRID (los campos actualizados se destacan en el ejemplo). Para obtener más información sobre las opciones que se muestran, consulta Propiedades de configuración del perfil de la organización para la API.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ { 
    "address1" : "Test address”,
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ], 
  "approveTrusted" : false, 
  "approveUntrusted" : false, 
  "billingCycle" : "CALENDAR_MONTH", 
  "country" : "US", 
  "currency" : "USD", 
  "description" : "Test organization", 
  "hasBillingAdjustment" : true, 
  "hasBroker" : false, 
  "hasSelfBilling" : false, 
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg", 
  "issueNettingStmt" : false, 
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}", 
  "nettingStmtPerCurrency" : false, 
  "regNo" : "RegNo-1234-myorg", 
  "selfBillingAsExchOrg" : false, 
  "selfBillingForAllDev" : false, 
  "separateInvoiceForFees" : false, 
  "status" : "ACTIVE", 
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID", 
  "taxRegNo" : "TaxRegNo-1234-myorg", 
  "timezone" : "UTC" 
}' \

-u email:password

Configura los tipos de facturación prepago y pospago con la API

Las cuentas de desarrollador se pueden configurar para usar los siguientes tipos de facturación: prepago, pospago o ambos.

Con las cuentas prepagadas, los desarrolladores pagan por adelantado el uso de tus APIs. Los fondos se deducen del saldo prepago del desarrollador, que se mantiene a través de un proveedor de pagos integrado. El desarrollador debe mantener un saldo prepago suficiente para comprar las APIs.

Con las cuentas pospago, los desarrolladores reciben una factura mensual al final del mes. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas por los planes incluidos en la factura.

Para configurar los tipos de facturación prepago y pospago de tu organización, establece la propiedad supportedBillingType en uno de los siguientes valores para indicar qué tipos de facturación son válidos: PREPAID, POSTPAID o BOTH. Si estableces el valor en BOTH, el valor predeterminado será PREPAID cuando agregues un desarrollador de apps o una empresa. En este caso, puedes establecer de forma explícita el tipo de facturación para una empresa o un desarrollador de aplicaciones con la API, como se describe en Administra empresas y desarrolladores de aplicaciones.

Por ejemplo:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
  "address" : [ {
    "address1" : "Test address",
    "city" : "Test City",
    "country" : "US",
    "id" : "corp-address",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "54321"
  } ],
  "approveTrusted" : false,
  "approveUntrusted" : false,
  "billingCycle" : "CALENDAR_MONTH",
  "country" : "US",
  "currency" : "USD",
  "description" : "Test organization",
  "hasBillingAdjustment" : true,
  "hasBroker" : false,
  "hasSelfBilling" : false,
  "hasSeparateInvoiceForProduct" : false,
  "id" : "myorg",
  "issueNettingStmt" : false,
  "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
  "name" : "{org_name}",
  "nettingStmtPerCurrency" : false,
  "regNo" : "RegNo-1234-myorg",
  "selfBillingAsExchOrg" : false,
  "selfBillingForAllDev" : false,
  "separateInvoiceForFees" : false,
  "status" : "ACTIVE",
  "supportedBillingType" : "POSTPAID",
  "taxModel" : "HYBRID",
  "taxRegNo" : "TaxRegNo-1234-myorg",
  "timezone" : "UTC"
  }' \
  -u email:password

Configura el ciclo de facturación con la API

Para configurar el ciclo de facturación de tu organización, establece la propiedad billingCycle en uno de los siguientes valores:

  • PRORATED: La facturación se basa en la cantidad de días que se usa un producto de API en un mes calendario.
  • CALENDAR_MONTH: La facturación se realiza mensualmente.

Por ejemplo:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \
  -H "Content-Type: application/json" \
  -d '{
    "address" : [ {
      "address1" : "Test address",
      "city" : "Test City",
      "country" : "US",
      "id" : "corp-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "54321"
    } ],
    "approveTrusted" : false,
    "approveUntrusted" : false,
    "billingCycle" : "CALENDAR_MONTH",
    "country" : "US",
    "currency" : "USD",
    "description" : "Test organization",
    "hasBillingAdjustment" : true,
    "hasBroker" : false,
    "hasSelfBilling" : false,
    "hasSeparateInvoiceForProduct" : false,
    "id" : "myorg",
    "issueNettingStmt" : false,
    "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg",
    "name" : "{org_name}",
    "nettingStmtPerCurrency" : false,
    "regNo" : "RegNo-1234-myorg",
    "selfBillingAsExchOrg" : false,
    "selfBillingForAllDev" : false,
    "separateInvoiceForFees" : false,
    "status" : "ACTIVE",
    "supportedBillingType" : "POSTPAID",
    "taxModel" : "HYBRID",
    "taxRegNo" : "TaxRegNo-1234-myorg",
    "timezone" : "UTC"
  }' \
  -u email:password

Propiedades de configuración del perfil de la organización para la API

El perfil de la organización te permite establecer las siguientes propiedades de configuración con la API.

Nombre Descripción Predeterminado ¿Obligatorio?
address

Dirección de la organización, que puede incluir la dirección, la ciudad, el estado, el código postal, el país y una indicación de si esta es la dirección principal de la organización

 N/A No
approveTrusted

Esta marca no se usa.

 N/A No
approveUntrusted

Esta marca no se usa.

 N/A No
billingCycle

Es el período del ciclo de facturación. El valor puede ser uno de los siguientes:

  • PRORRATEADO: La facturación se basa en la cantidad de días que se usa un producto de API en un mes calendario.
  • CALENDAR_MONTH: La facturación se realiza mensualmente.

Consulta Cómo configurar el ciclo de facturación con la API.

N/A Sí
country

Código ISO 3166-2 del país de operación de la organización, como BR para Brasil.

 N/A Sí
currency

Código ISO 4217 de la moneda contable o "base" que usa la organización (por ejemplo, USD para el dólar estadounidense).

Para los planes de reparto de ingresos: Se usa la moneda especificada para tu plan.

En el caso de los planes de tarjeta de tarifas (modelo de cobro), se aplica lo mismo que para los planes de participación en los ingresos. Sin embargo, puedes cambiar la configuración de la moneda a cualquiera que admita la organización.

En el caso de los planes solo con comisiones, puedes cambiar el parámetro de configuración de la moneda a cualquiera que admita la organización.

 N/A Sí
description

Es una breve descripción de la organización.

 N/A No
hasBillingAdjustment

Es una marca que especifica si se habilitaron los ajustes. Si está habilitado, puedes ajustar los detalles del tráfico que registran los Servicios de API para tus productos de API. El valor puede ser uno de los siguientes:

  • verdadero: Los ajustes están habilitados.
  • Falso: Los ajustes no están habilitados.
 N/A No
hasBroker

Es una marca que especifica si los ingresos se basan en el valor neto. El valor puede ser uno de los siguientes:

  • verdadero: Los ingresos se basan en el valor neto.
  • Falso: Los ingresos no se basan en el valor neto.
 N/A No
hasSelfBilling

Es una marca que dirige la monetización para que genere una factura de autocobro en lugar de una declaración de porcentaje de ingresos. Una factura de autoliquidación es un documento financiero en el que se detalla el importe que se le debe al desarrollador de apps. Actúa como una factura para el proveedor de la API en nombre del desarrollador de apps. El valor puede ser cualquiera de los siguientes:

  • verdadero: Genera facturas de facturación automática en lugar de declaraciones de reparto de ingresos.
  • false: Inhabilita las facturas de facturación automática.
 N/A No
hasSeparateInvoiceForProduct

Es una marca que especifica si se genera una factura independiente para cada producto de API. El valor puede ser cualquiera de los siguientes:

  • verdadero: Se genera una factura independiente para cada producto de API.
  • Falso: No se genera una factura independiente para cada producto de API.
 N/A No
id

Es el ID de la organización.

 N/A No
issueNettingStmt

Es una marca que especifica si se genera un estado de compensación cuando se crean documentos de facturación. El valor puede ser cualquiera de los siguientes:

  • verdadero: Se genera un resumen de compensación cuando se crean documentos de facturación.
  • Falso: No se genera un estado de compensación cuando se crean documentos de facturación.
 N/A No
logoUrl

Es la URL del logotipo de la organización.

 N/A No
name

Nombre de la organización.

 N/A Sí
netPaymentAdviceNote

Nota de asesoramiento sobre el pago neto.

 N/A No
nettingStmtPerCurrency

Es una marca que especifica si se genera un estado de compensación independiente para cada moneda utilizada. El valor puede ser cualquiera de los siguientes:

  • verdadero: Se genera un estado de compensación independiente para cada moneda utilizada.
  • Falso: No se genera un resumen de compensación independiente para cada moneda utilizada.
 N/A No
regNo

Número de registro de la organización. El número que ingreses para esta propiedad se mostrará en la parte inferior de los documentos de facturación.

 N/A No
selfBillingAsExchOrg

Si las facturas de autocobro están habilitadas, indica si están habilitadas para las organizaciones de intercambio. El valor puede ser cualquiera de los siguientes:

  • verdadero: Las facturas de autocobro están habilitadas para las organizaciones de intercambio.
  • Falso: Las facturas de autocobro no están habilitadas para las organizaciones de intercambio.
 N/A No
selfBillingForAllDev

Si las facturas de autocobro están habilitadas, indica si están habilitadas para todos los desarrolladores de apps. De forma predeterminada, las facturas de autofacturación solo se generan para los desarrolladores de aplicaciones que firmaron un acuerdo con el proveedor de la API. El valor puede ser cualquiera de los siguientes:

  • verdadero: Las facturas de autocobro están habilitadas para todos los desarrolladores de apps.
  • Falso: Las facturas de autocobro no están habilitadas para todos los desarrolladores de apps.
 falso No
separateInvoiceForFees

Es una marca que especifica si se publica una factura independiente para las comisiones. El valor puede ser cualquiera de los siguientes:

  • verdadero: Se publica una factura independiente para las comisiones.
  • Falso: No se publica una factura separada para las comisiones.
 falso Sí
status

Es el estado de la organización. Estos son algunos de los valores válidos:

  • ACTIVE: La cuenta de organización está registrada para la monetización y está disponible para su uso.
  • INACTIVE: La cuenta de organización está registrada para la monetización, pero no está disponible para su uso.
 N/A No
supportedBillingType

Es el modelo de pago para desarrolladores que se usa para la facturación. El valor puede ser uno de los siguientes:

  • PREPAID: El desarrollador paga por adelantado el uso de un producto de API. Los fondos se deducen del saldo del desarrollador cuando se usa el producto de API. El desarrollador debe mantener un saldo prepago suficiente para comprar el producto de API.
  • POSTPAID: Se le factura al desarrollador mensualmente (a través de una factura) por el uso de productos de API. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas por los planes incluidos en la factura.
  • BOTH: Admite cualquiera de los dos tipos de facturación. El valor predeterminado es PREPAID.

Consulta Cómo configurar tipos de facturación prepago y pospago con la API.

PREPAGO Sí
taxModel

Nota: Solo se aplica si configuras planes de tarifas con porcentaje de ingresos y deseas generar documentos de facturación.

Es el modelo fiscal para los planes de tarifas de reparto de ingresos que identifica el tipo de documentos de facturación requeridos.

Estos son algunos de los valores válidos:

  • Divulgado: El proveedor de la API actúa como agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) que se recaudan del usuario final se transfieren al desarrollador. La comisión del proveedor de la API se recauda del desarrollador en forma de una factura de comisión. El proveedor de la API no se encarga del impuesto sobre las ventas que se recauda del usuario final, y es responsabilidad del desarrollador informar el impuesto sobre las ventas.
  • No divulgado: El proveedor de la API actúa como agente no divulgado del desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga a las autoridades fiscales locales. El desarrollador factura al proveedor de la API por el porcentaje de ingresos netos que le corresponde (menos los impuestos sobre las ventas y la comisión del proveedor de la API).
  • Híbrido: El proveedor de la API actúa como agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas que se recauda de sus suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API le pasa los ingresos restantes al desarrollador y, luego, le factura los cargos por comisión.
 N/A Sí
taxNexus

Es el país en el que la organización está registrada a efectos fiscales.

 N/A No
taxRegNo

Número de registro fiscal o número de registro del impuesto sobre el valor agregado (IVA) de la organización, si corresponde Esta propiedad es opcional porque el número de registro fiscal o el número de registro del IVA no se aplican en todos los países. El número que ingreses para este parámetro se mostrará en la parte inferior de los documentos de facturación.

 N/A No
transactionRelayURL

Es la URL de otro sistema al que se pueden retransmitir las transacciones, como un almacén de datos.

 N/A No
timezone

Es el identificador de zona horaria para las operaciones de la organización, como America/New_York o Europe/Paris. También se admiten abreviaturas de zonas horarias, como UTC, EST (hora estándar del este) o CET (hora central europea).

 N/A Sí

Cómo anular la configuración del perfil de monetización de una empresa o un desarrollador de apps

Anula la configuración del perfil de monetización para una empresa o un desarrollador de apps con la IU o la API, como se describe en las siguientes secciones: