GET v1/contracts

Retuns the active advertiser contracts

Requer Autorização

Para realizar a autorização, é necessário enviar as credenciais de autenticação usando o cabeçalho de autorização.
O cabeçalho de autorização é construído como se segue:

O nome de usuário e a senha são combinadas em uma string "usuário:senha"
A seqüência resultante literal é então codificado em Base64
O método de autorização seguido da palavra "Basic" é, então, colocado antes da seqüência codificada.

Por exemplo, se o usuário é 'Aladdin' e a senha é "abra-de-sésamo" então o cabeçalho deve ser:
Authorization: Basic QWxhZGRpbjphYnJhLWRlLXPDqXNhbW8=

Códigos de Resposta

OK (200)
BadRequest (400)
Unauthorized (401)
Forbidden (403)
NotFound (404)

Informações da Resposta

Descrição do recurso

ContractResponse array Retorna uma lista com os contratos do anunciante.

Nome	Descrição	Tipo
Id	Código de identificação do Contrato do anunciante	integer
StartsAt	Data de início de vigência do contrato (Formato DD/MM/YYYY)	string
ExpiresAt	Data de expiração de vigência do contrato (Formato DD/MM/YYYY)	string
Status	Situação atual do contrato	string
HasAdsPlan	Indica se o contrato possui Plano de anúncios	boolean
HasWebsitePlan	Indica se o contrato possui Plano de Website particular (EmEstoque.com.br)	boolean

Formatos da Resposta

application/json, text/json

Observações:

No formato Json, os nomes dos parâmetros seguem o padrão camelCase, ou seja, sempre são iniciados com letras minúsculas.

[
  {
    "id": 1,
    "startsAt": "21/01/2025",
    "expiresAt": "21/02/2025",
    "status": "Active",
    "hasAdsPlan": true,
    "hasWebsitePlan": false
  },
  {
    "id": 1,
    "startsAt": "21/01/2025",
    "expiresAt": "21/02/2025",
    "status": "Active",
    "hasAdsPlan": true,
    "hasWebsitePlan": false
  }
]

text/html

[{"id":1,"startsAt":"21/01/2025","expiresAt":"21/02/2025","status":"Active","hasAdsPlan":true,"hasWebsitePlan":false},{"id":1,"startsAt":"21/01/2025","expiresAt":"21/02/2025","status":"Active","hasAdsPlan":true,"hasWebsitePlan":false}]

application/xml, text/xml

<ArrayOfContractResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContractResponse>
    <Id>1</Id>
    <StartsAt>21/01/2025</StartsAt>
    <ExpiresAt>21/02/2025</ExpiresAt>
    <Status>Active</Status>
    <HasAdsPlan>true</HasAdsPlan>
    <HasWebsitePlan>false</HasWebsitePlan>
  </ContractResponse>
  <ContractResponse>
    <Id>1</Id>
    <StartsAt>21/01/2025</StartsAt>
    <ExpiresAt>21/02/2025</ExpiresAt>
    <Status>Active</Status>
    <HasAdsPlan>true</HasAdsPlan>
    <HasWebsitePlan>false</HasWebsitePlan>
  </ContractResponse>
</ArrayOfContractResponse>