Administrar Términos y Condiciones

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

Introducción

Debes agregar términos y condiciones ("T&C") al perfil de tu organización antes de publicar un plan de tarifas. Los T&C's residen fuera del perfil de la organización En el perfil de tu organización, especificas la ubicación (URL pública) de los T&C's.

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

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

  1. Accede a la página Perfil de la organización, como se describe en Explora la página Perfil de la 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 que entran en vigencia los términos y condiciones. El valor predeterminado es la fecha actual. Debes ingresar la fecha actual o una fecha futura.
    Versión

    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&C se agregan a la sección Términos y condiciones de la página Perfil de la organización página.

  6. Repite los pasos del 3 al 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 términos y condiciones con la IU

No puedes editar los Términos y condiciones directamente. En cambio, 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 la organización, como se describe en Explora la página Perfil de la organización.
  2. Haz clic en Editar en la página Perfil de la organización.
  3. En la lista de T&C, coloca el cursor sobre los T&C que deseas borrar.
  4. Haz clic en .

Cómo administrar términos y condiciones con la API

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

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

Para agregar T&C, envía una solicitud POST a /mint/organizations/{org_name}/tncs. Cuando agregas los T&C, puedes especificar de forma opcional lo siguiente:

  • URL
  • Texto adjunto (como una descripción)
  • Fecha en que entran en vigencia los T&C
  • Número de versión

Consulta Propiedades de configuración de 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 términos y condiciones con la API

Consulta T&C específicos o todos los T&C de una organización.

Para ver T&C específicos , envía una solicitud GET a /mint/organizations/{org_name}/tncs/{tncs_id}, donde {tncs_id} es la identificación de los T&C específicos (el ID se muestra en la respuesta cuando creas los T&C). 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

Para ver todos los T&C's de la organización, envía una solicitud GET a /mint/organizations/{org_name}/tncs. 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
}

Cómo aceptar un documento de términos y condiciones para un desarrollador o una empresa con la API

Para aceptar un documento de T&C para un desarrollador o una empresa específicos, envía 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 del desarrollador (dirección de correo electrónico), {company_id} es el ID de la empresa y {tncs_id} es el ID del documento de 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",
      ...
  }
}

Cómo ver los términos y condiciones aceptados por un desarrollador o una empresa con la API

Para ver los T&C's aceptados por un desarrollador o una empresa específicos, envía una solicitud GET a una de las siguientes APIs, respectivamente:

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

Donde {dev_id} es el ID del 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
}

Cómo editar términos y condiciones con la API

Para editar T&C, envía una solicitud PUT a /mint/organizations/{org_named}/tncs/{tncs_id}, donde {tncs_id} es la identificación de los T&C. 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&C. Por ejemplo, la siguiente solicitud edita el número de versión de los T&C's (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 con la API

Para borrar T&C's, envía una solicitud DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, donde {tncs_id} es la identificación de los T&C's. 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 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 Predeterminado ¿Obligatorio?
url

URL de los T&C.

 N/A No
tncText

Texto (como una breve descripción) para los T&C.

 N/A No
version

Versión de los T&C. El número de versión te permite hacer un seguimiento de las diferentes versiones de los T&C.

 N/A Sí
startDate

Fecha en que entran en vigencia los T&C.

 N/A Sí
organization

Organización para los T&C.

 N/A No

Próximos pasos

Obtén información para agregar monedas admitidas a las que se configuraron inicialmente para tu organización en Administra las monedas admitidas.