API olx.com.br. Utilizando o sistema de importação de anúncios. Página 1 de 53

Transcrição

1 API olx.com.br Utilizando o sistema de importação de anúncios Página 1 de 53

2 Resumo Este documento descreve como utilizar o sistema de importação de anúncios para clientes de conta premium OLX através de uma aplicação web. Conta Premium é um serviço direcionado para os usuários de determinados segmentos que querem publicar um número elevado de anúncios através do sistema de integração. Este sistema é utilizado por clientes que possuem diversos anúncios e desejam automatizar o processo de publicação em massa no olx.com.br. O cliente envia um arquivo no formato JSON para o olx.com.br processar e realizar a inserção dos anúncios. Página 2 de 53

3 SUMÁRIO Resumo Autenticação oauth no OLX Requisição de importação ao servidor olx.com.br URL Me todo Operaço es Formato Codificação Exemplo Retorno Esperado Formato Sucesso Exemplo de Retorno Códigos e mensagens de retorno Exemplo de Retorno Códigos de Erro (-4) Parâmetros Parâmetros por Categoria Veículos category: 2020 (Carros) Exemplo category: 2060 (Motos) Exemplo Imóveis category: 1020 (Apartamento) Exemplo category: 1040 (Casas) Exemplo category: 1060 (Aluguel de Quartos) Página 3 de 53

4 category: 1080 (Temporada) Exemplo category: 1100 (Terrenos, sítios e fazendas) Exemplo category: 1120 (Lojas, salas e outros) Exemplo category: 1140 (Lançamentos) Exemplo Requisição de informação ao servidor olx.com.br URL Método Formato Exemplo Parâmetros Retorno esperado Formato Sucesso Parâmetros ads Exemplos Requisição das marcas e modelos dos veículos Carros URL Método Formato Exemplos Listar todas as marcas Listar todas os modelos da marca 6 (Audi) Listar todas as versões do modelo 3 (A3) da marca 6 (Audi) Motos URL Método Página 4 de 53

5 4.2.3 Formato Exemplos Listar todas as marcas Listar todas os modelos da marca 7 (Yamaha) Listar todas as versões do modelo 6 (Fazer) da marca 7 (Yamaha) Listar todas as cilindradas Consultar anúncios publicados URL Método Exemplo Retorno esperado Formato Sucesso Exemplo de retorno Página 5 de 53

6 1. Autenticação oauth no OLX Para utilizar a importação automática é necessário autenticar-se em nome de um usuário do OLX através do protocolo oauth. No processo de autenticação, o integrador utilizado deve ser homologado com o olx.com.br. O processo de homologação encontra-se descrito no manual (API olx.com.br - Utilizando o protocolo OAuth 2.0.pdf). No cadastro, o solicitante (Integrador/Administrador) receberá o client_id e o client_secret que deverão ser usados na url de conexão. Durante o fluxo oauth será requisitado ao usuário que dê permissão ao integrador para gerenciar seus anúncios no OLX através do sistema de importação. No handshake do oauth, é requisitado também o scope que a aplicação cliente necessitará. Para utilizar o sistema de importação automática, é preciso o scope autoupload. Página 6 de 53

7 2. Requisição de importação ao servidor olx.com.br O processo de importação de anúncios de forma automática no olx.com.br consiste no envio de um arquivo no formato JSON descrevendo um ou mais anúncios para inserção e/ou deleção. Ao receber este arquivo, nosso servidor faz a validação das informações presentes e insere os anu ncios em uma fila, onde sera o posteriormente processados e inseridos. Ao final do processamento do arquivo JSON, e gerado um token que sera retornado como resposta. Com esse token e possi vel consultar o status da importac a o e dos anu ncios importados. Um anu ncio importado passa pelos seguintes estados: pending: anu ncio na fila de inserc a o; queued: anu ncio inserido na fila de revisa o; accepted: anu ncio publicado; refused: anu ncio recusado; error: ocorreu um erro no anu ncio. Abaixo, as instruc o es para realizar uma importac a o: 2.1 URL A URL usada para fazer o envio do arquivo JSON e : Me todo O nosso servidor deve receber a requisic a o com me todo do tipo PUT. Página 7 de 53

8 2.3 Operaço es Na importac a o automa tica de anu ncios, e possi vel realizar operac o es de insert ou delete, que indicam, respectivamente, inserc a o ou delec a o de anu ncios. Para definir qual operac a o executar para um determinado anu ncio, deve-se utilizar o para metro operation em seu arquivo JSON. Insert - Indica a inserc a o de um anu ncio. Caso o anu ncio ja exista em nossa base, nosso sistema ira trata -lo como uma edic a o; Delete - Realiza a delec a o do anu ncio de nossa base. Neste caso, basta passar o id do anu ncio (ver exemplo abaixo). 2.4 Formato O formato do arquivo a ser enviado devera ser do tipo JSON. 2.5 Codificação O formato do encode do arquivo a ser enviado devera ser UTF Exemplo A seguir, um exemplo de um arquivo, contendo duas inserções e uma deleção: "access_token": "ca18abccaadd282490e75173f98b8ec6f0c1c6c8", "ad_list": [ "id": " ", "operation": "insert", "category": 2020, "subject": "Carro Novo", "body": "Corpo do anu nucio", "phone": , "type": "s", "price": 10500, "zipcode": " ", "params": "vehicle_brand": "3", "vehicle_model": "6", "vehicle_version": "2", Página 8 de 53

9 ],, "regdate": "1988", "gearbox": "1", "fuel": "1", "cartype": "2", "mileage": "10000", "doors": "1", "end_tag": "1", "car_features": [ "1", "2" ], "images": [ " " ] "id": " ", "operation": "insert", "category": 2020, "subject": "Carro Novo 2", "body": "Corpo do anu nucio 2", "phone": , "type": "s", "price": 12500, "zipcode": " ", "params": "regdate": "2001", "gearbox": "2", "fuel": "3", "cartype": "2", "mileage": "1", "doors": "1", "end_tag": "1", "car_features": [ "1", "2" ], "images": [ " ] "id": " ", "operation": "delete" Página 9 de 53

10 2.7 Retorno Esperado Formato O formato do retorno de nosso servidor será do tipo JSON Sucesso Parameter Value Description token statusmessa ge The ads were imported and will be processed Retorna uma com um token a ser usado para acessar o status do import Os anúncios foram importados e serão processados statuscode 0 errors array Retorna uma lista de erros Exemplo de Retorno "token": "06fb235e216f3095ba913654d10afee2f55eae35", "statuscode": 0, "statusmessage": "The ads were imported and will be processed", "errors": [] Página 10 de 53

11 2.7.4 Códigos e mensagens de retorno Em caso de erros no processamento/validação dos dados presentes no arquivo JSON, temos os seguintes códigos de retorno: Código Mensagem Descrição 0 The ads were imported and will be processed Os anúncios foram importados com sucesso e serão processados -1 Unexpected error Erro inesperado -2 The request was blocked -3 There is no ad to import -4 An ad had problems on import Usuário não pode importar pois está bloqueado temporariamente por excesso de requisições Não há anúncios para importar Se um anúncio falhar em sua validação, a importação é cancelada -5 Import is down O serviço de importação está desativado -6 Without permission Usuário sem permissão -7 Trying to import <n> ad(s), but user just have slot for <f> more. -8 Trying to import <n> ad(s), only <f> were imported ". "and will be processed. The following ads were ignored due to limit exceeded: " <t> O usuário está tentando importar <n> anúncios mas só podem importar mais <f>. Tentando importar <n> anúncios, só <f> foram importados e serão processados. Os seguintes anúncios foram ignorados devido ao limite excedido. Página 11 de 53

12 Exemplo de Retorno "token": null, "statuscode": -4, "statusmessage": "An ad had problems on import", "errors": [ "id": " ", "status": "error", "messages": [ "category": "ERROR_CATEGORY_INVALID" ] ] Página 12 de 53

13 Códigos de Erro (-4) Código ERROR_CATEGORY_INVALID ERROR_REGION_MISSING ERROR_ZIPCODE_INVALID ERROR_TYPE_INVALID ERROR_PHONE_INVALID ERROR_PHONE_TOO_SHORT ERROR_PHONE_TOO_LONG ERROR_BODY_TOO_SHORT ERROR_BODY_TOO_LONG ERROR_SUBJECT_TOO_SHORT ERROR_SUBJECT_TOO_LONG ERROR_FUEL_INVALID ERROR_FUEL_MISSING ERROR_CARTYPE_INVALID ERROR_DOORS_MISSING ERROR_ROOMS_INVALID ERROR_ROOMS_MISSING ERROR_CATEGORY_SUBTYPE_MISSING ERROR_SIZE_INVALID ERROR_UNKNOWN_APARTMENT_TYPE ERROR_MILEAGE_INVALID ERROR_REGDATE_INVALID Descrição Categoria inválida Região inválida CEP inválido Tipo inválido Número de telefone inválido Número de telefone muito curto Número de telefone muito longo Descrição muito curta Descrição muito longa Título muito curto Título muito longo Tipo de combustível inválido Tipo de combustível ausente Tipo de carro inválido Tipo de portas inválidos Total de quartos inválidos Número de quartos ausente Tipo de apartamento inválido Tamanho inválido Tipo de apartamento desconhecido Quilometragem incorreta Ano inválido para carro ERROR_UNKNOWN_CAR_FEATURES Parâmetro adicional de carros desconhecido Página 13 de 53

14 ERROR_NO_SUCH_PARAMETER ERROR_OPERATION_INVALID Indica que não existe o parâmetro passado Tipo de operação inválida 2.8 Parâmetros Os parâmetros para importação de anúncios são: Parâmetro Valores Tipo Obrigatóri o Descrição access_token id operation A identificação fornecida pelo olx.com.br através do handshake do oauth. insert delete sim Token de acesso Regular expression : [A-Za-z0-9_- ]1,19 sim O identificador do anúncio Sim Valores para identificar qual será a operação a ser feita: Insert - inserir anúncios Delete - apagar anúncios Página 14 de 53

15 category integer Sim Categoria do anúncio: 1020 Apartamentos 1040 Casas 1060 Aluguel de Quartos 1080 Temporada 1100 Terrenos, sítios e fazendas 1120 Lojas, salas e outros 1140 Lançamentos 2020 Carros 2060 Motos Subject Sim Título do anúncio Mínimo: 2 Máximo: 90 Body sim Descrição do anúncio Mínimo: 2 Máximo: 6000 Página 15 de 53

16 Phone númerica sim Telefone para contato Mínimo: 10 Máximo: 11 (telefones com 9 dígitos) Formato: <ddd><telefone> Exemplo: type "s" para categorias 2020 e "u" para categorias 1060 e sim Tipo de oferta do anúncio: s: venda u: aluguel "s" ou "u" para as demais price integer não Preço do anúncio (não aceita centavos) zipcode sim O CEP do anúncio. Caso o anúncio seja de uma categoria de Imóveis, deve ser o CEP do endereço do imóvel. Caso contrário, o CEP deve ser o do vendedor / loja. Página 16 de 53

17 params (ver tabela abaixo) images URL da imagem array não Lista de parâmetros com as características do anúncio. Os valores dessa lista variam de acordo com a categoria do anúncio. array de URL de imagens que serão inseridas no anúncio do olx.com.br. Não pode haver URLs repetidas neste array. Para carro só serão permitidas no máximo 6 imagens. No máximo 20 imágens nas outras categorias. Importante: a primeira imagem da lista será a imagem principal do anúncio! 2.9 Parâmetros por Categoria Cada categoria (parâmetro category) possui um conjunto de características próprias, que podem ser obrigatórias ou opcionais. Essas propriedades devem ser fornecidas através do parâmetro params. Como exemplo, temos, para a categoria 2020 (carros): Página 17 de 53

18 "access_token":"ca18abccaadd282490e75173f98b8ec6f0c1c6c8", "ad_list":[ "id":" ", "operation":"insert", "category":2020, "subject":"carro Novo", "body":"corpo do anúnucio", "phone": , "type":"s", "price":105, "zipcode":" ", "params": "vehicle_brand":"3", "regdate":"1988", "fuel":"1" ] Neste exemplo, temos no parâmetro params as propriedades vehicle_brand, regdate e fuel que descrevem a marca do veículo, ano de fabricação e tipo de combustível, respectivamente. A seguir, é fornecida a listagem completa de parâmetros para cada categoria e exemplos de uso Veículos category: 2020 (Carros) Parâmetro Valores Tipo Obrigatório Descrição vehicle_brand vehicle_model sim Marca do veículo (Ver tabela de marcas) não Modelo do veículo (ver tabela de modelos) Página 18 de 53

19 vehicle_version regdate 1950 até 2018 Valores aceitos no campo regdate: não sim Versão do veículo (ver tabelas de versões) Ano de Fabricação Até 1980 o ano deve ser múltiplo de (para ano de fabricação igual ou anterior a 1950) De 1980 até o ano corrente, deve ser enviado ano a ano: gearbox 1, 2 sim Tipo de Câmbio 1: Manual 2: Automático 3: Semi- Automático fuel 1, 2, 3, 4, 5 sim Tipo de Combustível 1: Gasolina 2: Álcool 3: Flex 4: Gás Natural 5: Diesel Página 19 de 53

20 mileage sim Quilometragem cartype 2, 3, 4, não Tipo do Veículo: 5, 6, 7, 2: Conversível 8, 9 3: Pick-up 4: Antigo 5: SUV 6: Buggy 7:Van/Utilitário 8: Sedã 9: Hatch Atenção: Item de id 1 era Passeio e foi dividido em duas novas opções Sedã e Hatch. doors 1, 2 não Total de Portas 1: 2 Portas 2: 4 Portas carcolor 1, 2, 3, não Cor do veículo: 4, 5, 6, 1: Preto 7, 8, 9, 2: Branco 10 3: Prata 4: Vermelho 5: Cinza 6: Azul 7: Amarelo 8: Verde 9: Laranja 10: Outra motorpower 1, 2, 3, não Potência do motor: 4, 5, 6, 1: 1.0 7, 8, 9, 2: , 11, 3: : 1.4 5: 1.5 Página 20 de 53

21 financial 1, 2, 3, 4 owner 1, 2 exchange 1, 2 car_steering 1, 2, 3, 4 end_tag 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 6: 1.6 7: 1.7 8: 1.8 9: : : : 4.0 ou mais não Situação financeira: 1: Financiado 2: IPVA Pago 3: Com multas 4: De leilão não Único dono: 1: sim 2: não não Aceita trocas: 1: sim 2: não não Tipo de direção: 1: Hidráulica 2: Elétrica 3: Mecânica 4: Assistida não 1: 0 2: 1 3: 2 4: 3 5: 4 6: 5 7: 6 8: 7 9: 8 10: 9 Página 21 de 53

22 car_features 1, 3, 4, 5, 6, 7, 8, 9, 10 array de s s não Características 1: Ar condicionado 3: Vidro elétrico 4: Trava elétrica 5: Air bag 6: Alarme 7: Som 8: Sensor de ré 9: Câmera de ré 10: Blindado Atenção: Item de id `2` era "Direção Hidráulica" que deixou de ser uma opção deste campo e ganhou um campo específico. Página 22 de 53

23 Exemplo "params": "vehicle_brand":"3", "vehicle_model":"6", "vehicle_version":"2", "regdate":"1988", "gearbox":"1", "fuel":"1", "cartype":"2", "mileage":"1", "doors":"1", "carcolor":"1", "motorpower":"1", "financial":"1", "owner":"1", "exchange":"1", "car_steering":"2", "end_tag":"1", "car_features": [ "1", "2" ] category: 2060 (Motos) Parâmetro Valores Tipo Obrigatório Descrição vehicle_brand vehicle_model vehicle_version sim Marca do veículo (Ver tabela de marcas) não Modelo do veículo (ver tabelas de modelos) não Versão do veículo (ver tabelas de versões) Página 23 de 53

24 regdate 1980 até 2018 Valores aceitos no campo regdate: sim Ano de Fabricação Até 1980 o ano deve ser múltiplo de (para ano de fabricação igual ou anterior a 1950) De 1980 até o ano corrente, deve ser enviado ano a ano: cubiccms mileage sim Cilindrada sim Quilometragem mototype 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 não Tipo de moto: 1: Street 2: Esportiva 3: Custom 4: Trail 5: Naked 6: Scooter 7: Offroad 8: Touring 9: Utilitária Página 24 de 53

25 carcolor 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 financial 1, 2, 3, 4 owner 1, 2 exchange 1, 2 não não não não 10: Supermotard 11: Triciclo 12: Quadriciclo 13: Trial 14: Mini Cross Cor do veículo: 1: Preto 2: Branco 3: Prata 4: Vermelho 5: Cinza 6: Azul 7: Amarelo 8: Verde 9: Laranja 10: Outra Situação financeira: 1: Financiado 2: IPVA Pago 3: Com multas 4: De leilão Único dono: 1: sim 2: não Aceita trocas: 1: sim 2: não Página 25 de 53

26 moto_features 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 array de s s não Características: 1: ABS 2: Computador de bordo 3: Escapamento esportivo 4: Bolsa / Baú / Bauleto 5: Contra peso no guidon 6: Alarme 7: Amortecedor de direção 8: Faróis de neblina 9: GPS 10: Som Página 26 de 53

27 Exemplo "params": "vehicle_brand":"1", "vehicle_model":"12", "vehicle_version":"7", "regdate":"2001", "mototype":"2", "cubiccms":"19", "mileage":"7000", "carcolor":"1", "motorpower":"1", "financial":"1", "owner":"1", "exchange":"1", "moto_features": [ "1", "2" ] Imóveis category: 1020 (Apartamento) Parâmetro Valores Tipo Obrigatório Descrição apartment_type 1, 2, 3, 4, rooms 1, 2, 5 3, 4, 5 sim sim Tipo do apartamento: 1 - Padrão 2 - Cobertura 3 - Duplex/ Triplex 4 - Kitchenette 5 - Loft/Studio Número de quartos: 1-1 Página 27 de 53

28 ou mais size* não Tamanho em metros Quadrado garage_spaces* não Quantidade de vagas de garagem. De 1 a 999 condomínio* não Valor do condomínio iptu* apartment_features 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 array de s s não não Valor do IPTU Características do apartamento: 1 - Ar condicionado 2 - Academia 3 - Armários embutidos 4 - Varanda 5 - Área de serviço 6 - Churrasqueira 7 - Quarto de empregada 8 - Piscina 9 - Salão de festas Página 28 de 53

29 10 - Porteiro 24h *Esses campos não podem ser enviados zerados ou em branco. Página 29 de 53

30 Exemplo "params": "apartment_type":"1", "rooms":"2", "size":"80", "garage_spaces":"4", "condominio":"300", "iptu":"100", "apartment_features": [ "1", "2" ] category: 1040 (Casas) Parâmetro Valores Tipo Obrigatório Descrição home_type 1, 2, 3 rooms 1, 2, size* 3, 4, 5 sim sim não Tipo do casa: 1 - Rua pública 2 - Vila 3 - Condomínio Fechado Número de quartos: ou mais Tamanho em metros Quadrado Página 30 de 53

31 garage_spaces* não Quantidade de vagas de garagem. De 1 a 999 condomínio* não Valor do condomínio iptu* home_features 1, 2, 3, 4, 5, 6, 7, 8 array de s s não não Valor do IPTU Características da casa: 1 - Ar condicionado 2 - Piscina 3 - Armários embutidos 4 - Varanda 5 - Área de serviço 6 - Churrasqueira 7 - Quarto de empregada 8 - Porteiro 24h *Esses campos não podem ser enviados zerados ou em branco. Página 31 de 53

32 Exemplo "params": "home_type":"1", "rooms":"2", "size":"80", "garage_spaces":"4", "condominio":"300", "iptu":"100", "home_features": [ "1", "2", "3" ] category: 1060 (Aluguel de Quartos) Esta categoria não tem parâmetros adicionais. Página 32 de 53

33 category: 1080 (Temporada) Parâmetro Valores Tipo Obrigatório Descrição season_type 1, 2, 3, 4, 5 rent_type 1, 2, 3, 4 season_features 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 array de s s sim sim não Tipo do apartamento: 1 - Apartamento 2 - Casa 3 - Quarto 4 - Quarto compartilhado 5 - Pousada Tipo de preço: 1 - por dia 2 - por semana 3 - por mês 4 - por pacote Características: 1 - Ar condicionado 2 - Aquecimento 3 - Café da manhã 4 - Churrasqueira 5 - Estacionamento 6 - Fogão 7 - Geladeira 8 - Internet 9 - Lareira 10- Máquina de lavar Página 33 de 53

34 11 - Permitido animais 12 - Piscina 13 - Roupa de cama 14 - Toalhas 15 - TV a cabo 16 - Ventilador 17 - Varanda/Terraço rooms 1, 2, 3, 4, 5 sim Número de quartos: ou mais beds 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, sim acomoda quantas pessoas: , 16, , Página 34 de 53

35 18-30 garage_spaces* não Quantidade de vagas de garagem. De 1 a 999 *Esses campos não podem ser enviados zerados ou em branco. Página 35 de 53

36 Exemplo "params": "season_type":"1", "rent_type":"1", "rooms":"2", "beds":"4", "season_features": [ "1", "2" ] category: 1100 (Terrenos, sítios e fazendas) Parâmetro Valores Tipo Obrigatório Descrição size* condomínio* iptu* re_land_type não não não não Tamanho em metros Quadrado Valor do condomínio Valor do IPTU Tipo do Imóvel: 1 - Terrenos e lotes 2 - Sítios e chácaras 3 - Fazendas 4 - Outros *Esses campos não podem ser enviados zerados ou em branco. Página 36 de 53

37 Exemplo "params": "size":"80", "condominio":"400", "iptu":"100", "re_land_type":"1" category: 1120 (Lojas, salas e outros) Parâmetro Valores Tipo Obrigatório Descrição size* garage_spaces* condomínio* iptu* não não não não Tamanho em metros Quadrado Quantidade de vagas de garagem. De 1 a 999 Valor do condomínio Valor do IPTU *Esses campos não podem ser enviados zerados ou em branco Exemplo "params": "size":"80", "garage_spaces":"4", "condominio":"400", "iptu":"100" Página 37 de 53

38 category: 1140 (Lançamentos) Parâmetro Valores Tipo Obrigatório Descrição re_release_type 1, 2, 3, 4 sim Tipo do imóvel: 1 - Apartamentos 2 - Casas 3 - Lojas e salas comerciais 4 - Terrenos e loteamentos Exemplo "price":"2100", "params": "re_release_type":"1" Página 38 de 53

39 3. Requisição de informação ao servidor olx.com.br Depois da importação automática, os anúncios irão para a fila de importação do olx.com.br para serem processados. É possível consultar o status da importação com o token retornado. Esta consulta retorna se a importação está pendente ou finalizada junto com as informações sobre cada anúncio, por exemplo, se foi rejeitado ou aceito. 3.1 URL A URL usada para fazer a requisição do arquivo JSON O token a ser inserido no final da URL é o retorno mencionado no item Método Nosso servidor deve receber a requisição com método do tipo POST 3.3 Formato O formato do arquivo a ser enviado para nosso servidor deverá ser do tipo JSON Exemplo A seguir, um exemplo do arquivo enviado no formato JSON: "access_token": " ab5961d8a029b224b8e1288e192062ef" Página 39 de 53

40 3.4 Parâmetros Os parâmetros suportados pelo servidor do olx.com.br são: Parâmetro Valores Tipo Obrigatório Descrição access_token A identificação fornecida pelo olx.com.br através do handshake do oauth. sim Token de acesso 3.5 Retorno esperado Formato O formato do retorno de nosso servidor será do tipo JSON Sucesso Parâmetro Valores Descrição autoupload_status done, pending Retorna o status dos anúncios. done: todos os anúncios foram processados (inseridos ou deletados) pending: Pelo menos um anúncio ainda está na fila de importação ads array[] Ver tabela abaixo Página 40 de 53

41 Parâmetros ads Parâmetro Valores Descrição status pending, error, queued, Retorna o status dos anúncios. accepted, refused pending: o anúncio será processado. error: o anúncio está com erro(s). queued: o anúncio foi inserido e será ativado em breve accepted: o anúncio foi ativado. Caso a operação seja de deleção, significa que o anúncio foi deletado. refused: o anúncio não foi ativado operation insert, delete Operação utilizada insert: inserção de anúncio delete: deleção de anúncio message ERROR_IMAGE_TOO_SMALL, Mensagens de aviso sobre erros ERROR_DOWNLOADING_IMAGE, ocorridos ERROR_UPLOADING_IMAGE list_id Retorna o id do seu anúncio, caso o mesmo tenha sido aprovado Página 41 de 53

42 Exemplos Para inserção/edição antes de entrar na fila de ativação "autoupload_status": "pending", "ads": " ": "status": "pending", "operation": "insert" Para anúncio inserido e aguardando ativação "autoupload_status": "pending", "ads": " ": "status": "queued", "operation": "insert", "message": [] Para edição antes da ativação "autoupload_status": "pending", "ads": " ": "status": "queued", "operation": "edit", "list_id": " ", "message": [] Para inserção ativada "autoupload_status": "done", "ads": " ": "status": "accepted", Página 42 de 53

43 "operation": "insert", "message": [], "url": " Para edição ativada "autoupload_status": "done", "ads": " ": "status": "accept", "operation": "edit", "list_id": " ", "message": [] Para inserção rejeitada "autoupload_status": "done", "ads": " ": "status": "refused", "operation": "insert", "message": [] Para edição rejeitada "autoupload_status": "done", "ads": " ": "status": "refused", "operation": "edit", "message": [] Para exclusão Página 43 de 53

44 "autoupload_status": "done", "ads": " ": "status": "accepted", "operation": "delete", "message": [] Página 44 de 53

45 4. Requisição das marcas e modelos dos veículos Ao utilizar o sistema de importação para anúncios das categorias "Carros" (2020) e Motos (2060), disponibilizamos uma consulta às marcas, modelos e versões dos mesmos, e no caso das motos, das cilindradas. 4.1 Carros URL A URL usada para fazer a requisição do arquivo JSON: Para listar todas as marcas disponíveis Para listar todos os modelos de determinada marca Para listar todas as versões de um determinado modelo _modelo Método Nosso servidor deve receber a requisição com método do tipo POST Formato O formato do arquivo a ser enviado para nosso servidor deverá ser do tipo JSON Exemplos Listar todas as marcas URL: Página 45 de 53

46 "access_token":"ca18abccaadd282490e75173f98b8ec6f0c1c6c8", Parte do retorno: "status": "ok", "data": "AM GEN": 1, "ACURA": 2, "AGRALE": 3, "ALFA ROMEO": 4, "ASIA MOTORS": 5, "AUDI": 6, "BMW": 7, "BRM": 8, "BUGGY": 9, "BUGRE": 10, "CBT JIPE": 11, "CHANGAN": Listar todas os modelos da marca 6 (Audi) URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77" Página 46 de 53

47 Parte do retorno: "status": "ok", "data": "80": 2, "100": 1, "A1": 3, "A3": 4, "A4": 5, "A5": 6, "A6": 7, "A7": 8, "A8": Listar todas as versões do modelo 3 (A3) da marca 6 (Audi) URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77" Retorno: "status": "ok", "data": "A1 1.4 TFSI 122CV S-TRONIC 3P": 1, "A1 SPORT 1.4 TFSI 185CV 3P S-TRONIC": 2, "A1 SPORTBACK 1.4 TFSI 185CV 5P S-TRONIC": 3, "A1 SPORTBACK 1.4 TFSI 5P S-TRONIC": 4, "A1 2.0 TFSI QUATTRO 256CV 3P": 5, "A1 SPORTBACK 1.8 TFSI 192CV 5P S-TRONIC": 6, "A1 SPORT. S EDITION 1.4 TFSI 5P S-TRONIC": 7 Página 47 de 53

48 4.2 Motos URL A URL usada para fazer a requisição do arquivo JSON: Para listar todas as marcas disponíveis Para listar todos os modelos de determinada marca Para listar todas as versões de um determinado modelo _modelo Para listar todas as cilindradas Método Nosso servidor deve receber a requisição com método do tipo POST Formato O formato do arquivo a ser enviado para nosso servidor deverá ser do tipo JSON Exemplos Listar todas as marcas URL: Página 48 de 53

49 "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77", Parte do retorno: "status": "ok", "data": "DUCATI": 1, "BUELL": 2, "KTM": 3, "KAHENA": 4, "FOX": 5, "MRX": 6, "YAMAHA": Listar todas os modelos da marca 7 (Yamaha) URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77", Parte do retorno: "status": "ok", "data": "750": 1, "AXIS": 2, Página 49 de 53

50 "BW'S": 3, "CRYPTON": 4, "DT": 5, "FAZER": Listar todas as versões do modelo 6 (Fazer) da marca 7 (Yamaha) URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77", Retorno: "status": "ok", "data": "FAZER 600/ FZ6 S": Listar todas as cilindradas URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77", Página 50 de 53

51 Retorno: "status": "ok", "data": "1": "50", "2": "125", "3": "250", "4": "500", "5": "750", "6": "1000", "7": "150", "8": "200", "9": "300", "10": "350", "11": "400", "12": "450", "13": "550", "14": "600", "15": "650", "16": "700", "17": "800", "18": "850", "19": "900", "20": "950", "21": "Acima de 1.000", "22": "100" Página 51 de 53

52 5. Consultar anúncios publicados Depois da importação automática, os anúncios irão para a fila de importação do olx.com.br para serem processados. Esta consulta retorna todos os anúncios que já foram processados e estão ativos, ou seja, disponíveis para visualização em nosso site por qualquer usuário da OLX. 5.1 URL A URL usada para fazer a requisição do arquivo JSON Método Nosso servidor deve receber a requisição com método do tipo POST Exemplo A seguir, um exemplo de requisição: URL: "access_token":"2cb68a524c25b9a934e9edf4102ef82db5babd77", Página 52 de 53

53 5.3 Retorno esperado Formato O formato do retorno de nosso servidor será do tipo JSON Caso o usuário não tenha nenhum anúncio ativo, será retornado um array vazio, tendo anúncios será retornado array conforme consta no exemplo Sucesso Parâmetro Valores Descrição id Regular expression: [A-Za-z0-9_-]1,19 Identificador do anúncio definido pelo usuário list_id integer id do anúncio na OLX Exemplo de retorno [ ], "id": "original-id-01", "list_id": " " "id": "original-id-02", "list_id": " " Página 53 de 53