Administrar Términos y Condiciones

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

Introducción

Debes agregar términos y condiciones ("Términos y Condiciones") al perfil de tu organización antes de publicar un plan de tarifas. Los Términos y Condiciones se encuentran fuera del perfil de la organización. En el perfil de la organización, especifica la ubicación (URL pública) de los Términos y Condiciones.

Después de publicar un plan de tarifas, la versión actual de los Términos y Condiciones se muestra en el portal para desarrolladores. Los desarrolladores solo pueden comprar un plan después de haber aceptado los Términos y Condiciones actuales.

Cómo agregar términos y condiciones con la IU

  1. Accede a la página Perfil de organización, como se describe en Explora la página Perfil de organización.
  2. Haz clic en Editar.
  3. En la sección Términos y Condiciones de la página Perfil de la organización, haz clic en Agregar términos y condiciones.

    Se muestra el diálogo Nuevos términos y condiciones.

  4. Ingresa la siguiente información:
    Campo Descripción
    Fecha de entrada en vigencia

    Fecha en la que los términos y condiciones entran en vigencia. El valor predeterminado es la fecha actual. Debes ingresar la fecha actual o una fecha futura.

    Versión

    Es la versión de los términos y condiciones. El número de versión te permite hacer un seguimiento de las diferentes versiones de los Términos y Condiciones.

    URL

    URL de los términos y condiciones.

  5. Haz clic en Crear.

    Los nuevos Términos y Condiciones se agregan a la sección de Términos y Condiciones de la página del perfil de la organización.

  6. Repite los pasos 3 a 5 para agregar términos y condiciones adicionales.
  7. Haz clic en Guardar para guardar los cambios del perfil de la organización.

Cómo editar los Términos y Condiciones con la IU

No puedes editar los Términos y Condiciones directamente. En su lugar, debes borrar los términos y condiciones que deseas editar y, luego, agregar una nueva entrada de términos y condiciones.

Cómo borrar términos y condiciones con la IU

  1. Accede a la página Perfil de organización, como se describe en Explora la página Perfil de organización.
  2. Haz clic en Editar en la página Perfil de la organización.
  3. En la lista de Términos y Condiciones, coloca el cursor sobre los Términos y Condiciones que quieras borrar.
  4. Haz clic en .

Administración de términos y condiciones mediante la API

Administra los términos y condiciones mediante la API, como se describe en las siguientes secciones.

Cómo agregar términos y condiciones mediante una API

Envía una solicitud POST a /mint/organizations/{org_name}/tncs para agregar los Términos y Condiciones. Cuando agregues los Términos y Condiciones, tendrás la opción de especificar lo siguiente:

  • URL
  • Texto complementario (como una descripción)
  • Fecha en la que entran en vigencia los Términos y Condiciones
  • Número de versión

Consulta las Propiedades de configuración de los Términos y Condiciones para obtener información adicional sobre estas opciones.

Por ejemplo:

curl -X POST   "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "url":"www.testoperator/termsandconditions",
     "tncText":"Sample text for the T&C",
     "version":"1.1",
     "startDate":"2018-09-24"
  }' \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
   "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
   "organization" : {     
     …
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.1"
 }

Cómo ver los Términos y Condiciones con la API

Ver los Términos y Condiciones específicos o todos los Términos y Condiciones de una organización.

Consulta los Términos y Condiciones específicos mediante una solicitud GET a /mint/organizations/{org_name}/tncs/{tncs_id}, en la que {tncs_id} es la identificación de los Términos y Condiciones específicos (el ID se muestra en la respuesta cuando creas los Términos y Condiciones). Por ejemplo:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

Envía una solicitud GET a /mint/organizations/{org_name}/tncs para ver todos los Términos y Condiciones de la organización. Por ejemplo:

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

A continuación, se proporciona un ejemplo de la respuesta.

{

"tnc" : [
  {
    "id" : "77193339-8d79-44a8-8af2-3593f16c158e",
    "organization" :
    {
      ...
    },
   "startDate" : "2018-07-01 00:00:00",
   "tncText" : "Big operator text for the T&C",
   "url" : "www.bigoperator/termsandconditions",
   "version" : "1.0"
  },
  {
    "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
    "organization" : {
    ...
  },
    "startDate" : "2018-09-24 00:00:00",
    "tncText" : "Sample text for the T&C",
    "url" : "www.testoperator/termsandconditions",
    "version" : "1.1"
  }
  ]
   "totalRecords" : 2
}

Aceptación de un documento de términos y condiciones para un desarrollador o una empresa que utiliza la API

Acepta un documento de Términos y Condiciones de un desarrollador o una empresa específicos mediante la emisión de una solicitud POST a una de las siguientes APIs, respectivamente:

  • /mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

Donde {dev_id} es el ID de desarrollador (dirección de correo electrónico), {company_id} es el ID de la empresa y {tncs_id} es el ID de documento de los Términos y Condiciones.

Por ejemplo:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "action":"ACCEPTED",
     "auditDate":"2018-10-01 00:00:00"
  }' \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

Nota: En la carga útil de la respuesta, auditDate se establece en la hora actual en UTC.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Visualización de los términos y condiciones que aceptó un desarrollador o una empresa a través de la API

Envía una solicitud GET a una de las siguientes APIs para ver los Términos y Condiciones que aceptó un desarrollador o una empresa específicos:

  • /mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/developer-tncs

Donde {dev_id} es el ID de desarrollador (dirección de correo electrónico) y {company_id} es el ID de la empresa.

Por ejemplo:

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

A continuación, se proporciona un ejemplo de la respuesta.

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

Edición de los términos y condiciones mediante la API

Edita los Términos y Condiciones mediante una solicitud PUT a /mint/organizations/{org_named}/tncs/{tncs_id}, en la que {tncs_id} es la identificación de los Términos y Condiciones. Cuando realices la actualización, deberás especificar en el cuerpo de la solicitud la configuración actualizada y la identificación de los Términos y Condiciones. Por ejemplo, la siguiente solicitud edita el número de versión de los Términos y Condiciones (la propiedad actualizada se destaca en el ejemplo):

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
  -H "Content-Type: application/json" \
  -d {
    "id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
    "version":"1.2"
  }' \
  -u email:password

A continuación, se proporciona un ejemplo de la respuesta.

{
   "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9",
   "organization" : {
       "address" : [ {
       "address1" : "Test address",
       "city" : "Test City",
       "country" : "US",
       "id" : "test-address",
       "isPrimary" : true,
       "state" : "CA",
       "zip" : "54321"
     } ],
     …"
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.2"
 }

Cómo borrar términos y condiciones mediante la API

Borra los Términos y Condiciones mediante una solicitud DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, en la que {tncs_id} es la identificación de los Términos y Condiciones. Por ejemplo:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

Propiedades de configuración de los Términos y Condiciones para la API

En la siguiente tabla, se resumen las propiedades de configuración que se pueden establecer con la API para los términos y condiciones.

Nombre Descripción Predeterminada ¿Obligatorio?
url

URL de los Términos y Condiciones.

No disponible No
tncText

Texto (como una breve descripción) de los Términos y Condiciones

No disponible No
version

Versión de los Términos y Condiciones. El número de versión te permite hacer un seguimiento de las diferentes versiones de los Términos y Condiciones.

No disponible
startDate

Fecha en la que entran en vigencia los Términos y Condiciones.

No disponible
organization

Organización de los Términos y Condiciones.

No disponible No

Próximos pasos

Obtén información sobre cómo agregar monedas admitidas a las configuradas inicialmente para tu organización en Administra las monedas admitidas.