Administra el perfil de la organización

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

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

Información sobre el perfil de la organización

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

Debes editar el perfil de la organización para agregar o actualizar 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 moneda o el modelo de impuestos.

Configura información básica sobre tu organización, que incluye lo siguiente:

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

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

Explora la página Perfil de organización

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

Conexión de integración

Para acceder a la página Perfil de la organización con la IU de Edge, sigue estos pasos:

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

Se mostrará la página del perfil de la organización.

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

  • Ver la configuración actual del perfil de la organización
  • Editar la configuración del perfil de la organización, incluidas las siguientes acciones:

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

Para acceder a la página Perfil de la organización 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. En la barra de navegación superior, selecciona Administrador > Perfil de la organización.

Se mostrará la página del perfil de la organización.

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

  • Ver la configuración actual del perfil de la organización
  • Editar la configuración del perfil de la organización, incluidas las siguientes acciones:

Editar el perfil de la organización con la IU

Para editar el perfil de la organización con la IU, sigue estos pasos:

  1. Accede a la página Perfil de la organización.
  2. Haz clic en Editar.
  3. En Información y nombre, edita el nombre de la organización y el país en el que opera.
  4. En Impuestos y moneda, edita los siguientes campos:
    Campo Descripción
    Modelo fiscal

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

    Es un 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 un agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) recaudados del usuario final se pasan al desarrollador. La comisión del proveedor de la API se cobra al desarrollador como una factura de comisión. El proveedor de la API no controla el impuesto sobre las ventas recaudado del usuario final, y es responsabilidad del desarrollador declararlo.
    • No divulgado: El proveedor de la API actúa como un agente no divulgado por el desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga a las autoridades tributarias locales. El desarrollador factura al proveedor de la API por el reparto de ingresos netos que debe pagar al desarrollador (menos impuestos sobre las ventas y la comisión del proveedor de la API).
    • Híbrido: El proveedor de la API actúa como un agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas recaudado de sus suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API pasa los ingresos restantes al desarrollador y, luego, factura los cargos de comisión.
    Moneda

    Las monedas que admite tu organización. En el caso de los planes de reparto de ingresos, de hoja de tarifas y solo de tarifas, se usa la moneda predeterminada del plan de tarifas. Cuando creas una hoja de tarifas o un plan solo de tarifas, puedes cambiar la moneda que quieres usar. Para ello, selecciona una de las opciones de 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 cuenta prepagado para cada moneda.

    Para agregar una moneda, sigue estos pasos:

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

    Para borrar una moneda, coloca el cursor sobre la que quieras 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.

Consulta el perfil de la organización con la API

Envía una solicitud GET a /mint/organizations/{org_name} para ver el perfil de tu organización. 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. Si deseas 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"
}

Editar el perfil de la organización con la API

Para editar el perfil de la organización, emite una solicitud PUT a /mint/organizations/{org_name}. Cuando editas el perfil de la organización, debes especificar todas sus propiedades, no solo las que estás editando.

Para editar la moneda predeterminada de la organización, establece el valor 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 currency a USD y la configuración del modelo de impuestos a HYBRID (los campos actualizados se destacan en el ejemplo). Si deseas 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

Cómo configurar tipos de facturación prepagada 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 para usar tus APIs. Los fondos se deducen del saldo prepagado del desarrollador, que se mantiene a través de un proveedor de pagos integrado. El desarrollador debe mantener un saldo prepagado suficiente para comprar las APIs.

Con las cuentas de pospago, los desarrolladores reciben una factura mensual (a través de una factura) a fin de 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 prepagada 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 usar la API para configurar explícitamente el tipo de facturación para una empresa o un desarrollador de apps, como se describe en Cómo administrar empresas y desarrolladores de apps.

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

Cómo configurar 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 durante 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 mediante la API.

Nombre Descripción Predeterminada ¿Obligatorio?
address

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

No disponible No
approveTrusted

Esta marca no se usa.

No disponible No
approveUntrusted

Esta marca no se usa.

No disponible No
billingCycle

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

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

Consulta Configura el ciclo de facturación con la API.

No disponible
country

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

No disponible
currency

Código ISO 4217 para la "base" o la moneda contable que usa la organización (como el dólar estadounidense para el dólar estadounidense).

En el caso de los planes de reparto de ingresos: Se usa la moneda especificada para el plan.

En los planes de hoja de tarifas (modelo de carga): Se aplica lo mismo que en los planes de reparto de ingresos. Sin embargo, puedes cambiar la configuración de moneda a cualquier moneda que admita la organización.

Para los planes solo de tarifas: Puedes cambiar la configuración de moneda a cualquier moneda que admita la organización.

No disponible
description

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

No disponible No
hasBillingAdjustment

Marca que especifica si se habilitaron los ajustes Si se habilita, puedes realizar ajustes en los detalles de tráfico que registran los servicios de API para tus productos de API. El valor puede ser cualquiera de los siguientes:

  • true: Los ajustes están habilitados.
  • false: Los ajustes no están habilitados.
No disponible No
hasBroker

Marca que especifica si los ingresos se basan en el valor neto. El valor puede ser cualquiera de los siguientes:

  • true: Los ingresos se calculan en función del valor neto.
  • false: Los ingresos no se basan en el valor neto.
No disponible No
hasSelfBilling

Marca que indica a la monetización que genere una factura de facturación propia en lugar de un resumen de reparto de ingresos. Una factura de autofacturación es un documento financiero que detalla el importe que se debe pagar al desarrollador de la app. Actúa como una factura para el proveedor de API en nombre del desarrollador de apps. El valor puede ser cualquiera de los siguientes:

  • true: Genera facturas de facturación propia en lugar de resúmenes de reparto de ingresos.
  • false: Inhabilita las facturas de autofacturación.
No disponible No
hasSeparateInvoiceForProduct

Marca que especifica si se genera una factura por separado para cada producto de API. El valor puede ser cualquiera de los siguientes:

  • true: Se genera una factura independiente para cada producto de API.
  • false: No se genera una factura independiente para cada producto de API.
No disponible No
id

ID de la organización.

No disponible No
issueNettingStmt

Marca que especifica si se genera un estado de cuenta cuando se crean documentos de facturación. El valor puede ser cualquiera de los siguientes:

  • true: El estado de cuenta se genera cuando se crean documentos de facturación.
  • false: El estado de cuenta no se genera cuando se crean los documentos de facturación.
No disponible No
logoUrl

URL del logotipo de la organización.

No disponible No
name

Nombre de la organización.

No disponible
netPaymentAdviceNote

Nota de aviso de pago neto.

No disponible No
nettingStmtPerCurrency

Marca que especifica si se genera una declaración de compensación separada para cada moneda que se usa. El valor puede ser cualquiera de los siguientes:

  • true: Se genera una declaración de compensación separada para cada moneda utilizada.
  • false: No se genera una declaración de compensación separada para cada moneda utilizada.
No disponible 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.

No disponible No
selfBillingAsExchOrg

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

  • true: Las facturas de autofacturación están habilitadas para organizaciones de intercambio.
  • false: Las facturas de autofacturación no están habilitadas para las organizaciones de intercambio.
No disponible No
selfBillingForAllDev

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

  • true: Las facturas de autofacturación están habilitadas para todos los desarrolladores de apps.
  • false: Las facturas de autofacturación no están habilitadas para todos los desarrolladores de apps.
false No
separateInvoiceForFees

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

  • true: Se publica una factura por separado para las tarifas.
  • false: No se publican facturas independientes para las tarifas.
false
status

Estado de la organización. Estos son algunos de los valores válidos:

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

Se utiliza el modelo de pago del desarrollador para la facturación. El valor puede ser uno de los siguientes:

  • PREPAGA: El desarrollador paga por adelantado por 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 prepagado suficiente para comprar el producto de API.
  • POSPAGA: El desarrollador recibe una factura mensual (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 cualquier tipo de facturación. La configuración predeterminada es PREPAID.

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

PREPAGADAS
taxModel

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

Es un 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 un agente divulgado del desarrollador. Los ingresos brutos (incluidos los impuestos sobre las ventas) recaudados del usuario final se pasan al desarrollador. La comisión del proveedor de la API se cobra al desarrollador como una factura de comisión. El proveedor de la API no controla el impuesto sobre las ventas recaudado del usuario final, y es responsabilidad del desarrollador declararlo.
  • No divulgado: El proveedor de la API actúa como un agente no divulgado por el desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga a las autoridades tributarias locales. El desarrollador factura al proveedor de la API por el reparto de ingresos netos que debe pagar al desarrollador (menos impuestos sobre las ventas y la comisión del proveedor de la API).
  • Híbrido: El proveedor de la API actúa como un agente divulgado del desarrollador. Sin embargo, el proveedor de la API paga el impuesto sobre las ventas recaudado de sus suscriptores a las autoridades fiscales locales en nombre del desarrollador. El proveedor de la API pasa los ingresos restantes al desarrollador y, luego, factura los cargos de comisión.
No disponible
taxNexus

El país en el que está registrada la organización para fines impositivos.

No disponible No
taxRegNo

Número de registro fiscal de la organización o número de registro del Impuesto sobre el valor agregado (IVA), si corresponde Esta propiedad es opcional porque el número de registro fiscal o el número de registro de 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.

No disponible No
transactionRelayURL

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

No disponible No
timezone

El identificador de zona horaria para las operaciones de la organización, como America/New_York o Europa/París. También se admiten las abreviaturas de zona horaria, como UTC, EST (hora estándar del este) o CET (hora de Europa central).

No disponible

Anula 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 de una empresa o un desarrollador de apps que usa la IU o la API, como se describe en las siguientes secciones: