Aplicação de destaque em anúncio

Aplicação de destaque em anúncio

A URL usada para fazer a requisição do arquivo JSON é https://apps.olx.com.br/autoupload/bump/ad/{ad_id}, método PUT. Essa requisição deve conter o token de cada anunciante no header como: Authorization: Bearer <token>.

O campo token pode ser obtido seguindo a documentação Autenticação na API olx.com.br.

Parâmetro	Valores	Obrigatório	Descrição
ad_id	string	sim	Identificador do anúncio.
token	string	sim	Chave de acesso do anunciante

Se o anunciante possui um plano profissional ativo e o destaque for aplicado, a requisição retorna um status code 200 e um JSON no corpo da resposta com a estrutura:

Retorno de sucesso esperado

Parâmetro	Valores	Obrigatório	Descrição
next_bumps	arrayOf[string (ISO Datetime)]	sim	Próximas datas agendadas para a volta do anúncio ao topo (ou seja, para a reaplicação do destaque).

A quantidade de datas retornadas no campo next_bumps, dependerá do plano contratado, podendo ser de 1 a 5.

Retorno de erro esperado

Caso ocorra algum erro ou o anunciante não possua plano profissional ativo, a consulta retorna um status code >= 400 e um JSON com o motivo e a mensagem do erro.

Códigos e motivos de erros da requisição retornados

Status Code	Descrição	Motivo	Mensagem
400	Falta campo de authorization no header da requisição	BAD_REQUEST	Check the header field(s)
401	Token inválido	ACCESS_DENIED	Check the client authentication token
403	Cliente não tem saldo disponível para aplicar o destaque	FORBIDDEN	{ "reason": "FORBIDDEN", "message": "Forbidden." }
404	Anúncio não encontrado	NOT FOUND	{ "reason": "NOT_FOUND", "message": "Ad not found." }
422	Bump já aplicado	BUMP_ALREADY_APPLIED_OR_NOT_SYNCHRONIZED	{ "reason": "BUMP_ALREADY_APPLIED_OR_NOT_SYNCHRONIZED", "message": "Bump already applied or Ad not synchronized." }
429	Rate Limit configurado quando o cliente fizer mais requisições por segundo do que o permitido	RATE_LIMIT	You have exceeded the X requests in X seconds limit!
500	Erro interno inesperado	UNEXPECTED_INTERNAL_ERROR	Unexpected internal error. Try again later

Exemplos de retorno

Ao aplicar destaque, o anúncio terá sua visibilidade aumentada indo para o topo da listagem de anúncios e retornaremos uma lista de datas futuras onde o destaque será novamente aplicado no período de 7 dias.

• Request

  curl -X PUT "https://apps.olx.com.br/autoupload/bump/ad/{ad_id}" -H "accept: application/json" -H "Content-Type: application/json" -H "authorization: Bearer {token}"
  

• Response

  HTTP/1.1 200 OK
  Content-Type: application/json;charset=UTF-8
  Cache-Control: no-store
  Pragma: no-cache
  
  {
      "next_bumps": ["2022-09-01 00:00:00.00000", "2022-09-05 00:00:00.00000"]
  }
  

---

Em caso de erro

• Request

  curl -X PUT "https://apps.olx.com.br/autoupload/bump/ad/{ad_id}" -H "accept: application/json" -H "Content-Type: application/json" -H "authorization: Bearer {token}"
  

• Response

  HTTP/1.1 404
  Content-Type: application/json;charset=UTF-8
  Cache-Control: no-store
  Pragma: no-cache
  
  {
      "reason": "NOT_FOUND",
      "message": "Ad not found."
  }
  

---

Para uma requisição com token inválido:

• Request

  curl -A Mozila -H "Authorization: Bearer <token>" "https://apps.olx.com.br/autoupload/balance"
  

• Response

  HTTP/1.1 401 
  Content-Type: application/json;charset=UTF-8
  Cache-Control: no-store
  Pragma: no-cache
  
  {
      "reason": "ACCESS_DENIED", 
      "message": "Check the client authentication token."
  }
  

---

Para o anúncio que já foi dado destaque:

Obs: Uma vez o destaque aplicado e ativo, só será permitida a re-aplicação de novo destaque no anúncio após o prazo de 7 dias.

• Request

  curl -X PUT "https://apps.olx.com.br/autoupload/bump/ad/{ad_id}" -H "accept: application/json" -H "Content-Type: application/json" -H "authorization: Bearer {token}"
  

• Reponse

  HTTP/1.1 422
  Content-Type: application/json;charset=UTF-8
  Cache-Control: no-store
  Pragma: no-cache
  
  { 
      "reason": "BUMP_ALREADY_APPLIED_OR_NOT_SYNCHRONIZED", 
      "message": "Bump already applied or Ad not synchronized." 
  }