Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. Más información
Introducción
Debes agregar los términos y condiciones ("Términos y Condiciones") a tu perfil de organización antes de publicar un plan de tarifas. Las condiciones del servicio residen fuera del perfil de la organización. En el perfil de tu organización, especificas la ubicación (URL pública) de las CGU.
Después de publicar un plan de tarifas, la versión actual de las Condiciones del Servicio se muestra en el portal para desarrolladores. Los desarrolladores solo pueden comprar un plan después de aceptar los Términos y Condiciones actuales.
Agrega términos y condiciones con la IU
- Accede a la página Perfil de la organización, como se describe en Explorar la página Perfil de la organización.
- Haz clic en Editar.
- 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 cuadro de diálogo Nuevos términos y condiciones
- Ingresa la siguiente información:
Campo Descripción Fecha de entrada en vigencia Fecha en la que entran en vigencia los Términos y Condiciones. El valor predeterminado es la fecha actual. 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 hacer un seguimiento de las diferentes versiones de los Términos y Condiciones.
URL URL de los Términos y Condiciones
- Haz clic en Crear.
Los nuevos Términos y Condiciones se agregarán a la sección Términos y Condiciones de la página Perfil de la organización.
- Repita los pasos 3 a 5 para agregar términos y condiciones adicionales.
- Haz clic en Guardar para guardar los cambios en el 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 quieras editar y, luego, agregar una nueva entrada.
Cómo borrar los Términos y Condiciones con la IU
- Accede a la página Perfil de la organización, como se describe en Explorar la página Perfil de la organización.
- Haz clic en Editar en la página Perfil de la organización.
- En la lista de Términos y Condiciones, coloca el cursor sobre aquellos que desees borrar.
- 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
Para agregar las condiciones del servicio, envía una solicitud POST a /mint/organizations/{org_name}/tncs.
Cuando agregues las condiciones del servicio, puedes especificar lo siguiente de forma opcional:
- URL
- Texto complementario (como una descripción)
- Fecha de entrada en vigencia de los Términos y Condiciones
- Número de versión
Consulta 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
Consulta los Términos y Condiciones específicos o todos los Términos y Condiciones de una organización.
Para ver las Condiciones del Servicio específicas, envía una solicitud GET a /mint/organizations/{org_name}/tncs/{tncs_id}, en la que {tncs_id} es la identificación de las Condiciones del Servicio específicas (el ID se muestra en la respuesta cuando creas las Condiciones del Servicio). 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 todas las condiciones del servicio 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
}
Aceptar un documento de términos y condiciones para un desarrollador o una empresa que usa la API
Para aceptar un documento de Términos y Condiciones de 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.
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
Para consultar los Términos y Condiciones 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
}
Edita los Términos y Condiciones con la API
Para editar las condiciones del servicio, envía una solicitud PUT a /mint/organizations/{org_named}/tncs/{tncs_id}, donde {tncs_id} es la identificación de las condiciones del servicio. Cuando realices la actualización, debes especificar en el cuerpo de la solicitud
la configuración actualizada y la identificación de las Condiciones del Servicio. Por ejemplo, la siguiente solicitud edita el número de versión de las Condiciones del Servicio (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"
}
Borra los términos y condiciones con la API
Para borrar las condiciones del servicio, envía una solicitud DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, donde {tncs_id} es la identificación de las condiciones del servicio. 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 de la API
En la siguiente tabla, se resumen las propiedades de configuración que se pueden establecer con la API de los Términos y Condiciones.
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
url |
Es la URL de las condiciones del servicio. |
N/A | No |
tncText |
Texto (como una breve descripción) de los Términos y Condiciones. |
N/A | 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 las Condiciones del Servicio. |
N/A | Sí |
startDate |
Fecha en la que entran en vigencia las Condiciones del Servicio |
N/A | Sí |
organization |
Organización de las condiciones del servicio |
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.