Administrar Términos y Condiciones

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X.
información

Introducción

Debes agregar términos y condiciones (“Términos y Condiciones”) a tu perfil de organización para poder publicar un plan de tarifas. Los Términos y Condiciones residen fuera de la organización perfil. En tu perfil de organización, debes especificar la ubicación (URL pública) de la 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 en el portal para desarrolladores. Los desarrolladores pueden comprar un plan solo después de haber aceptado el plan Términos y Condiciones.

Agrega términos y condiciones con la IU

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

    Se mostrará el diálogo Nuevos términos y condiciones

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

    Fecha de entrada en vigencia de los Términos y Condiciones El valor predeterminado es el fecha. Debes ingresar la fecha actual o una futura.

    Versión

    Versión de los Términos y Condiciones. El número de versión te permite mantener 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 Términos y Condiciones del Perfil de la organización. .

  6. Repita 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 puede editar los Términos y Condiciones directamente. En su lugar, debes borrar los términos y condiciones que deseas editar y, luego, agrega una nueva entrada de Términos y Condiciones.

Cómo borrar Términos y Condiciones con la IU

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

Administra los Términos y Condiciones con la API

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

Agrega términos y condiciones con 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, tienes la opción de especificar lo siguiente:

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

Consulta las propiedades de configuración de los Términos y Condiciones para obtener más información información 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"
 }

Ver los Términos y Condiciones con la API

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

Ver detalles Términos y Condiciones mediante el envío de una solicitud GET a /mint/organizations/{org_name}/tncs/{tncs_id}, donde {tncs_id} es la identificación de los Términos y Condiciones específicos (el ID se muestra en el cuando crees 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

Ver todos los Términos y Condiciones de la organización enviando 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
}

Aceptar un documento de Términos y Condiciones para un desarrollador o una empresa que usa la API

Emite una solicitud POST para aceptar los Términos y Condiciones de un desarrollador o una empresa específicos 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",
      ...
  }
}

Consulta los términos y condiciones que acepta un desarrollador o una empresa mediante la API

Consulta los Términos y Condiciones aceptados por un desarrollador o una empresa específicos mediante la emisión de 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
}

Edita los Términos y Condiciones con la API

Editar los Términos y Condiciones enviando una solicitud PUT a /mint/organizations/{org_named}/tncs/{tncs_id}, donde {tncs_id} es la la identificación de los Términos y Condiciones. Cuando realices la actualización, deberás especificarlo en la solicitud. la configuración actualizada y la identificación de los Términos y Condiciones. Por ejemplo, el siguiente solicitar modificaciones en 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 con la API

Borrar Términos y Condiciones enviando una solicitud DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, donde {tncs_id} es la 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 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.

N/A No
tncText

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

N/A No
version

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

N/A
startDate

Fecha de entrada en vigencia de los Términos y Condiciones.

N/A
organization

Organización para los Términos y Condiciones.

N/A No

Próximos pasos

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