Preparar envio do ícone
Obtenha uma URL temporária para enviar o ícone do checkout.
Informe os dados de uma imagem quadrada para obter a URL temporária de envio do ícone. Depois de enviar o arquivo, associe o identificador retornado à configuração do checkout.
Essa requisição não troca o ícone por si só. Confira as etapas em Logo e ícone do checkout.
Cabeçalhos
Chave única escolhida pelo seu sistema para identificar esta requisição. Ao repetir a tentativa, envie a mesma chave e os mesmos parâmetros. Sem este header, a requisição é processada normalmente. Consulte o guia de idempotência para os prazos e o tratamento de respostas pendentes ou incertas.
1 a 255 caracteres
Parâmetros do corpo
Usar exemplo substitui os campos do corpo.
Tipo de conteúdo do arquivo: image/png ou image/jpeg.
1 a 32 caracteres
Tamanho do arquivo em bytes.
De 1 a 524288
Largura do ícone em pixels. Deve ser igual à altura.
De 128 a 512
Altura do ícone em pixels. Deve ser igual à largura.
De 128 a 512
Respostas
Corpo da resposta
Envio autorizado até o prazo retornado. Envie o arquivo para upload_url antes de associar o ID à personalização do checkout.
Autorização temporária para enviar um arquivo de imagem da empresa, no ambiente autenticado.
Identificador do envio. Use-o no campo correspondente do PATCH depois de enviar o arquivo.
URL temporária para envio dos bytes do arquivo. Não envie a chave de API Raims para este endereço.
Método HTTP para enviar o arquivo à URL retornada.
Tipo de conteúdo que deve ser enviado no header Content-Type do PUT.
Quantidade de bytes que deve ser enviada, também informada no header Content-Length do PUT.
Prazo de validade da autorização de envio, em segundos Unix UTC.
Corpo da resposta
Os dados da imagem não atendem aos formatos, tamanhos ou dimensões aceitos. Corrija os campos indicados nos detalhes.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Corpo da resposta
A conta não foi encontrada para a chave informada. Confira a credencial antes de repetir a requisição.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.