Gerenciar Termos e Condições

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Introdução

É necessário adicionar os termos e condições ("T&Cs") ao perfil da sua organização antes de publicar um plano de taxas. Os T&Cs estão fora do perfil da organização. No perfil da sua organização, você especifica o local (URL público) dos Termos e Condições.

Depois de publicar um plano de tarifas, a versão atual dos T&Cs será exibida no portal do desenvolvedor. Os desenvolvedores só podem comprar um plano depois de aceitar os Termos e Condições atuais.

Como adicionar termos e condições usando a interface

  1. Acesse a página "Perfil da organização", conforme descrito em Como usar a página "Perfil da organização".
  2. Clique em Editar.
  3. Na seção Termos e Condições da página "Perfil da organização", clique em Adicionar termos e condições.

    A caixa de diálogo "Novos termos e condições" é exibida.

  4. Digite as seguintes informações:
    Campo Descrição
    Início da vigência

    Data em que os termos e condições entraram em vigor. O padrão é a data atual. Você precisa inserir a data atual ou uma data futura.
    Versão

    Versão dos Termos e Condições. O número da versão permite acompanhar diferentes versões dos Termos e Condições.
    URL

    URL dos Termos e Condições.
  5. Clique em Criar.

    Os novos T&Cs são adicionados à seção "Termos e condições" do perfil da organização.

  6. Repita as etapas 3 a 5 para adicionar mais termos e condições.
  7. Clique em Salvar para salvar as mudanças no perfil da organização.

Como editar Termos e Condições usando a interface

Não é possível editar os Termos e Condições diretamente. Em vez disso, exclua os Termos e Condições que você quer editar e adicione uma nova entrada.

Como excluir termos e condições usando a interface

  1. Acesse a página "Perfil da organização", conforme descrito em Como usar a página "Perfil da organização".
  2. Clique em Editar na página "Perfil da organização".
  3. Na lista de T&Cs, posicione o cursor sobre os T&Cs que você quer excluir.
  4. Clique em .

Como gerenciar termos e condições usando a API

Gerencie os termos e condições usando a API, conforme descrito nas seções a seguir.

Adicionar Termos e Condições usando uma API

Adicione os T&Cs emitindo uma solicitação POST para /mint/organizations/{org_name}/tncs. Ao adicionar os T&Cs, você pode especificar:

  • URL
  • Texto complementar (como uma descrição)
  • Data em que os T&C estão em vigor
  • Número da versão

Consulte Propriedades de configuração dos Termos e Condições para mais informações sobre essas opções.

Exemplo:

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

Veja a seguir um exemplo de resposta:

{
   "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"
 }

Como conferir os Termos e Condições usando a API

Visualizar termos e condições específicos ou todos os termos e condições de uma organização.

Para conferir os T&Cs específicos, faça uma solicitação GET para /mint/organizations/{org_name}/tncs/{tncs_id}, em que {tncs_id} é a identificação dos T&Cs específicos. O ID é retornado na resposta quando você cria os T&Cs. Exemplo:

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

Confira todos os T&C da organização emitindo uma solicitação GET para /mint/organizations/{org_name}/tncs. Exemplo:

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

Veja a seguir um exemplo de resposta:

{

"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
}

Aceitar um documento de Termos e Condições para um desenvolvedor ou uma empresa que usa a API

Aceite um documento de T&C para um desenvolvedor ou empresa específico emitindo uma solicitação POST para uma das seguintes 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

Em que {dev_id} é o ID do desenvolvedor (endereço de e-mail), {company_id} é o ID da empresa e {tncs_id} é o ID do documento de termos e condições.

Exemplo:

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

Veja a seguir um exemplo de resposta:

Observação: no payload de resposta, o auditDate é definido como o horário atual em UTC.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Como conferir os termos e condições aceitos por um desenvolvedor ou empresa que usa a API

Para conferir os T&C aceitos por um desenvolvedor ou empresa específico, emita uma solicitação GET para uma das seguintes APIs, respectivamente:

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

em que {dev_id} é o ID do desenvolvedor (endereço de e-mail) e {company_id} é o ID da empresa.

Exemplo:

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

Veja a seguir um exemplo de resposta:

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

Como editar termos e condições usando a API

Edite os T&C emitindo uma solicitação PUT para /mint/organizations/{org_named}/tncs/{tncs_id}, em que {tncs_id} é a identificação dos T&C. Ao fazer a atualização, você precisa especificar no corpo da solicitação as configurações atualizadas e a identificação dos T&Cs. Por exemplo, a solicitação a seguir edita o número da versão dos Termos e Condições (a propriedade atualizada está destacada no exemplo):

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

Veja a seguir um exemplo de resposta:

{
   "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"
 }

Como excluir termos e condições usando a API

Exclua os T&C emitindo uma solicitação DELETE para /mint/organizations/{org_name}/tncs/{tncs_id}, em que {tncs_id} é a identificação dos T&C. Exemplo:

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

Propriedades de configuração de termos e condições da API

A tabela a seguir resume as propriedades de configuração que podem ser definidas usando a API para termos e condições.

Nome Descrição Padrão Obrigatório?
url

URL dos Termos e Condições.

 N/A Não
tncText

Texto (como uma breve descrição) para os T&C.

 N/A Não
version

Versão dos T&C. O número da versão permite acompanhar as diferentes versões dos T&C.

 N/A Sim
startDate

Data em que os Termos e Condições entraram em vigor.

 N/A Sim
organization

Organização dos Termos e Condições.

 N/A Não

Próximas etapas

Saiba como adicionar moedas aceitas às que foram configuradas inicialmente para sua organização em Gerenciar moedas aceitas.