Administra el perfil de la organización

Estás viendo la documentación de Apigee Edge.
Ve a 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.

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 tu perfil de la 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 moneda o el modelo fiscal.

Configurar la información básica sobre la organización, incluido 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 mes calendario)
  • Moneda base
  • Modelo fiscal que usa tu organización

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

Explorar la página del perfil de la organización

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

Edge

Para acceder a la página del 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 organización en la barra de navegación izquierda.

Se muestra la página del 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:

  • Ver la configuración actual del perfil de la organización
  • Editar la configuración del perfil de la organización, incluidos los siguientes elementos:

Classic Edge (nube privada)

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

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

La página del perfil de la 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, incluidos los siguientes elementos:

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 de 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 de operación.
  4. En Impuestos y moneda, edita los siguientes campos:
    Campo Descripción
    Modelo fiscal

    Nota: Se aplica solo si configuras planes de tarifas de reparto de ingresos y quieres para generar documentos de facturación.

    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:

    • Aviso: 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 son pasan al desarrollador. La comisión del proveedor de la API se cobra de desarrollador en forma de 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 para declarar el impuesto sobre las ventas.
    • No divulgado: el proveedor de la API actúa como un agente no divulgado de al desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga al a las autoridades tributarias locales. El desarrollador factura al proveedor de la API por los ingresos netos. parte adeudada al desarrollador (menos impuestos sobre las ventas y la política de comisión).
    • 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 su suscriptores a las autoridades tributarias locales en nombre del desarrollador. La API el proveedor pasa los ingresos restantes al desarrollador y, luego, factura cargos de comisión.
    Moneda

    Las monedas que admite tu organización Para los planes de reparto de ingresos, hoja de tarifas y solo de tarifa, se usa la moneda predeterminada en tu plan de tarifas. Cuando creas una hoja de tarifas o un plan de solo tarifa, puedes cambiar la moneda a la que para usar seleccionando 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 prepagado de su cuenta 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 prepagado de su cuenta en la moneda especificada en el campo Cantidad mínima de recargas.
    4. Haz clic en Agregar.
    5. Si lo deseas, puedes establecerla como la moneda predeterminada haciendo 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 ella y haz clic en la .
  5. Administra los Términos y Condiciones, como se describe en Cómo administrar 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.

Cómo ver 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 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

Editar el perfil de la organización enviando una solicitud PUT a /mint/organizations/{org_name} Cuando edites el perfil de la organización, debes especificar todos los propiedades del perfil de la organización, no solo las propiedades que usted edita.

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

Por ejemplo, la siguiente llamada a la API actualiza el currency a USD y el modelo fiscal la configuración en HYBRID (los campos actualizados se destacan en el ejemplo). Para ver más información sobre las opciones que se muestran, consulta Configuración de perfiles de la organización Propiedades 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 prepagados y pospago con la API

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

Con las cuentas prepagadas, los desarrolladores pagan por adelantado por el uso de 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, a los desarrolladores se les factura mensualmente (a través de una factura) al final del mes. El desarrollador paga por el uso de los productos de API según las condiciones de pago establecidas en los planes incluidos en la factura.

Para configurar los tipos de facturación prepagados y pospago para tu organización, establece la propiedad supportedBillingType en una de las siguientes opciones: siguientes valores para indicar qué tipos de facturación son válidos: PREPAID, POSTPAID o BOTH. Si estableces el valor en BOTH, la configuración predeterminada será PREPAID cuando agregues un desarrollador de apps o una empresa. En este caso, puedes configurar explícitamente el tipo de facturación para una empresa o un desarrollador de apps usando la API, como se describe en Administra 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

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 organización para la API

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

Nombre Descripción Predeterminada ¿Obligatorio?
address

Dirección de la organización, que puede incluir la dirección, la ciudad, el estado o el código postal código, 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

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

  • PROPORCIONADO: La facturación se basa en la cantidad de días que se usa un producto de API en una 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 operaciones de la organización, como Brasil para Brasil.

 N/A Sí
currency

código ISO 4217 para la "base" o Moneda de contabilidad que usa la organización (como USD para los Estados Unidos) dólares).

En el caso de los planes de reparto de ingresos: La moneda especificada se usa para el plan.

Para los planes de hojas de tarifas (modelo de cobro): Se aplica lo mismo que para los planes de reparto de ingresos. Sin embargo, puedes cambiar la configuración de moneda a cualquier moneda que admita la organización.

Para planes exclusivos de tarifas: puedes cambiar la configuración de moneda a cualquier moneda que admita dentro de la organización.

 N/A Sí
description

Breve descripción de la organización.

 N/A No
hasBillingAdjustment

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

  • true: Los ajustes están habilitados.
  • false: Los ajustes no están habilitados.
 N/A No
hasBroker

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

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

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

  • true: Genera facturas de autofacturación en lugar de resúmenes de reparto de ingresos.
  • false: Inhabilita las facturas de autofacturación.
 N/A No
hasSeparateInvoiceForProduct

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

  • true: Se genera una factura independiente para cada producto de API.
  • false: 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

Marca que especifica si se genera un resumen de compensación cuando se crea la facturación documentos. El valor puede ser cualquiera de los siguientes:

  • true: El resumen de cuenta neta se genera cuando se crean los documentos de facturación.
  • Falso: El resumen de cuenta neta no se genera cuando se crean los documentos de facturación.
 N/A No
logoUrl

URL del logotipo de la organización.

 N/A No
name

Nombre de la organización.

 N/A Sí
netPaymentAdviceNote

Nota de aviso sobre el pago neto.

 N/A No
nettingStmtPerCurrency

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

  • true: Se genera una declaración 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 ingresas para esta propiedad es que aparece en la parte inferior de los documentos de facturación.

 N/A No
selfBillingAsExchOrg

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

  • true: Las facturas de autofacturación están habilitadas para las organizaciones de intercambios.
  • Falso: Las facturas de autofacturación no están habilitadas para las organizaciones de intercambio.
 N/A No
selfBillingForAllDev

Si se habilitan las facturas de autofacturación, indica si están habilitadas para todos desarrolladores de apps. De forma predeterminada, las facturas de autofacturación se generan solo para los desarrolladores de apps que tienen firmó 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.
 falso No
separateInvoiceForFees

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

  • true: Se publica una factura independiente para las tarifas.
  • falso: Las facturas independientes no se publican para las tarifas.
 falso Sí
status

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

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

Modelo de pago del desarrollador que se usa para la facturación El valor puede ser uno de los siguientes:

  • PREPAGA: El desarrollador paga por adelantado el uso de un producto de API. Los fondos son se deduce del saldo del desarrollador cuando se usa el producto de API. El desarrollador mantener un saldo prepagado suficiente para comprar el producto de API.
  • POSTPAID: Se factura al desarrollador mensualmente (mediante una factura) por el uso de la API. productos. El desarrollador paga por el uso de productos de API en función de las condiciones de pago establecidas. 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 prepagados y pospago con la API.

PREPAGA Sí
taxModel

Nota: Se aplica solo si configuras planes de tarifas de reparto de ingresos y quieres para generar documentos de facturación.

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:

  • Aviso: 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 son pasan al desarrollador. La comisión del proveedor de la API se cobra de desarrollador en forma de 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 para declarar el impuesto sobre las ventas.
  • No divulgado: el proveedor de la API actúa como un agente no divulgado de al desarrollador, deduce el impuesto recaudado de los usuarios finales y lo paga al a las autoridades tributarias locales. El desarrollador factura al proveedor de la API por los ingresos netos. parte adeudada al desarrollador (menos impuestos sobre las ventas y la política de comisión).
  • 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 su suscriptores a las autoridades tributarias locales en nombre del desarrollador. La API el proveedor pasa los ingresos restantes al desarrollador y, luego, factura cargos de comisión.
 N/A Sí
taxNexus

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

 N/A No
taxRegNo

Número de registro fiscal de la organización o 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 de IVA no se aplica en todos los países. El número que ingresas para esto se muestra en la parte inferior de los documentos de facturación.

 N/A No
transactionRelayURL

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

 N/A No
timezone

El identificador de zona horaria para las operaciones de la organización, como América/Nueva_York o Europa/París. abreviaciones de zonas horarias, como UTC, EST (este también se admite la hora estándar) o CET (hora de Europa central).

 N/A Sí

Anula la configuración del perfil de monetización para una empresa o un desarrollador de apps

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