Fastcommerce Developers Center

Sobre a Adm360

A Adm360 é a API administrativa da Fastcommerce. Ela permite que aplicações autorizadas consultem recursos administrativos e executem operações de acordo com as permissões do usuário da loja.

Este manual descreve os comandos atualmente disponíveis na Adm360. A disponibilidade efetiva de cada recurso depende da permissão do usuário, da configuração da loja e dos objetos liberados para a sessão.

Integre ERPs, CRMs, sistemas de BI e gateways de pagamento para consultar dados, gerenciar pedidos e executar os recursos administrativos disponíveis à sua aplicação.

1 - Acessando a API

O acesso ocorre por HTTPS (porta 443). Os comandos usam FORM POST e as respostas documentadas são JSON. A execução é síncrona; o tempo de resposta depende do comando e da quantidade de registros processados.

Endpoint geral:

https://www.rumo.com.br/adm/Adm360.ehc

O comando UPL possui endpoint separado para upload multipart: https://www.rumo.com.br/adm/Adm360UploadExec.asp.

A resposta pode ser quase imediata ou demorar alguns minutos, conforme o volume processado. Consulte os limites em Melhores práticas. Os exemplos usam FORM POST; UPL utiliza multipart/form-data.

2 - Histórico de versões

A versão da API permanece 1.0. Esta revisão amplia a documentação dos comandos já existentes e não altera, por si só, o contrato do servidor.

3 - Loja para testes

O Fastcommerce não tem um ambiente de sandbox para realizar testes. Sugerimos portanto que crie uma loja para testes para desenvolver com a API.

Acesse o endereço http://novaloja.fastcommerce.com.br para criar sua loja de testes. Após cadastrá-la, avise-nos qual é o nome e o ID desta nova loja através do e-mail comercial@fastcommerce.com.br para que possamos deixar a loja em implantação e a mesma não seja cancelada após o prazo de avaliação.

4 - Usuário para testes

O usuário que vai consumir a API precisa basicamente de acesso aos relatórios e utilitários da loja, pois é através dele que as consultas e alterações são feitas.

Essa etapa deve ser realizada por um usuário da loja com permissão para criar novos usuários.

Acesse a administração da loja e no menu "Usuários" clique na opção "Incluir usuário".

O cadastro pode ser preenchido como no exemplo abaixo. A imagem ilustra a tela; conceda apenas as permissões necessárias à integração.

Crie um usuário exclusivo para cada integração, com senha forte e somente as permissões necessárias. Não reutilize usuários pessoais e não grave senha ou token em código, log, evidência ou documentação.

A permissão é verificada pelo servidor em cada comando. A existência de um comando neste manual não concede acesso a ele.

5 - Melhores Práticas

Seguem algumas dicas para melhor utilização da API:

• 5.1) Para maximizar a performance na alteração de pedidos, inclua no JSON somente os campos obrigatórios e os campos que serão alterados. Não inclua no JSON campos que não serão alterados.

• 5.2) Existe um limite de até 100 chamadas à API de pedidos por hora. Para maximizar o uso de cada chamada ao comando OrderManagement (OMN), é possível incluir mais de um registro que será afetado em cada chamada. Por exemplo, é possível incluir e alterar vários pedidos em uma mesma chamada. Se este limite for excedido, novas requisições serão bloqueadas até a próxima virada da hora. Por exemplo, se forem feitas mais de 100 requisições entre 13h e 14h, somente após as 14h será possível fazer novos acessos à API, e assim por diante. Quando o limite for excedido, o erro "ErrOrdersAccessLimit" será retornado pela API, com a seguinte mensagem: Reached limit of access per hour.

• Encerre a sessão com LOU quando concluir o uso.
• Verifique o resultado de cada item nos lotes REG e OMN.
• Após timeout em uma escrita, confira o estado antes de reenviar: a operação pode ter sido aplicada.
• Proteja senha, token e dados pessoais nos registros da integração.

6 - Comandos da API

Os comandos abaixo estão apresentados em ordem de uso. Salvo quando indicado, a chamada usa FORM POST para o endpoint geral e deve conter cmd, StoreID e, após o login, token.

7 - Permissões de acesso

Para o acesso a API, é necessário que o usuário tenha permissões de acordo com cada método:

As permissões são configuradas na ficha do usuário da loja e verificadas pelo servidor. Os níveis abaixo são mínimos: Leitura (1), Inclusão (2), Alteração (3) e Exclusão (4). Um nível superior atende ao mínimo indicado, mas não cria operações que a tabela não oferece.

7.1 - Permissões por tabela REG

Cada célula indica o nível mínimo no módulo da linha. O traço significa que a operação não é oferecida por REG, mesmo para um usuário com nível superior.

A exclusão de banners, cupons, parceiros, localidades e tarifas exige Alteração (3); notícias e modelos de mensagens exigem Exclusão (4). As proteções de negócio continuam valendo, por exemplo para cupons utilizados e origens protegidas. Em reportUtilities, a permissão é por categoria, não uma comparação numérica com os níveis 1 a 4.

Atenção:

Acessos à API não devem estar diretamente relacionados aos acessos a qualquer página da loja virtual, ou seja, cada acesso de cliente da loja não deve corresponder a um acesso à API. Para evitar que isto ocorra, existe uma limitação no volume de acessos por hora aos métodos da API.

Obs: É extremamente recomendado criar um usuário específico para cada aplicação que for utilizar a API. Este usuário deve ter nome de usuário e senha fortes e únicas. Insira as permissões de acordo com que a aplicação irá utilizar. Por exemplo, se a aplicação irá apenas acessar os dados de pedidos, basta inserir acesso a relatórios de pedidos e em todos os demais campos deixar sem acesso.

8 - LIN, LOU e HLP

8.1 - LIN - Login

Use LIN para iniciar uma sessão e obter o token utilizado nos demais comandos.

<form action="https://www.rumo.com.br/adm/Adm360.ehc" method="POST">
  <input name="StoreName" value="STORE_NAME">
  <input name="StoreID" value="STORE_ID">
  <input name="Username" value="API_USERNAME">
  <input name="Password" value="API_PASSWORD">
  <input name="cmd" value="LIN">
</form>

A resposta pode conter cmd, id, st, usr, tk, err, errDescr, begin, end e et. O campo tk é segredo. Envie seu valor no campo token das chamadas seguintes.

8.2 - LOU - Logout

Use LOU ao encerrar o uso da API. Envie cmd=LOU, StoreID e token. Uma resposta ErrOK confirma o encerramento; a integração também deve descartar localmente o token após a tentativa.

8.3 - HLP - Ajuda de recursos

Use HLP após o login para descobrir tabelas, campos, tipos e ações liberadas ao usuário. Envie cmd=HLP, StoreID e token. O parâmetro opcional table permite consultar uma tabela específica. A ajuda das tabelas REG não substitui o catálogo de relatórios e utilitários.

Atenção: o resultado de HLP descreve os campos e as ações REG disponíveis; o servidor valida as permissões em cada operação. Não presuma que uma tabela ou operação desta documentação estará liberada para todo usuário.

9 - REL e UTL

9.1 - REL - Relatórios

REL executa relatórios autorizados pelo catálogo da loja. Os campos mais usados são ObjectID ou ObjectName, Page, QtRecords, TipoPesquisa, Fields e Par1 até Par8.

Consulte primeiro a tabela reportUtilities com REG para obter o catálogo permitido, os parâmetros e os limites. A estrutura de retorno pode conter metadados como fields, fieldsTypes, dbTypes e dados tabulares. Uma página sem registros e um resultado válido.

9.2 - UTL - Utilitários

UTL executa utilitários cadastrados no catálogo autorizado. Alguns utilitários podem gerar CSV, ZIP, redirecionamentos ou efeitos de escrita. Antes de automatizar, confirme objeto, parâmetros, efeito esperado e retorno na loja de testes autorizada.

REL e UTL não aceitam ordenação arbitrária do cliente; a consulta disponível é definida pelo objeto autorizado. Não repita automaticamente uma chamada cujo resultado tenha ficado incerto.

10 - REG - Cadastros

REG recebe o campo actions com um array JSON. Cada ação usa a para a operação, t para a tabela e, quando aplicável, id, f para pares campo/valor, out, order, page e pageSize.

[
  {
    "a": "r",
    "t": "news",
    "out": ["id", "title", "date", "enable"],
    "order": ["id"],
    "page": 1,
    "pageSize": 20
  }
]

Limites conhecidos: até 11 ações por chamada, sendo até 10 leituras e 5 escritas; o JSON de actions possui limite de 4096 caracteres, incluindo a serialização e os escapes. Confira o resultado individual de cada ação, inclusive quando o erro geral for ErrOK.

10.1 - Tabelas disponíveis

As tabelas abaixo são as atualmente catalogadas. A permissão efetiva e os campos aceitos devem sempre ser conferidos pelo HLP.

Não há tabelas REG genéricas para produtos, clientes, categorias ou pedidos. Consultas de produtos, clientes e pedidos devem usar REL quando o objeto estiver autorizado; pedidos também podem ser incluídos ou alterados com OMN.

11 - FMG e UPL - Arquivos

11.1 - FMG - Gestão de arquivos

FMG administra arquivos e pastas da loja. As operações conhecidas são list, create, edit, rename, delete e zip. Os campos variam por operação e incluem operation, path, filter, page, pageSize, items, folderName, fileName e fileContent.

Comece por list. Valide o caminho retornado antes de criar, editar, renomear, excluir ou compactar. Não há contrato dedicado de mover, baixar ou ler conteúdo por FMG; preview e download dependem da URL pública configurada pela loja.

11.2 - UPL - Upload multipart

UPL usa multipart/form-data no endpoint de upload. Envie token, StoreID ou IDLoja, Path, MaxFiles, FileType, SaveAs0 até SaveAs3, Overwrite0 até Overwrite3 e os arquivos.

O backend suporta até quatro arquivos por chamada. O limite total documentado é 4 MiB; arquivos comuns possuem limite padrão de 400 KiB. ZIP possui limites específicos por área. A sobrescrita deve ser escolha explícita: omita o campo quando não desejar sobrescrever. Não envie a string false: o campo preenchido pode habilitar a sobrescrita.

12 - OMN - Pedidos

OMN recebe o JSON OrdersData. O cmd do formulário deve ser OMN; o campo orders[].cmd define insert ou update para cada pedido.

<form action="https://www.rumo.com.br/adm/Adm360.ehc" method="POST">
  <input name="StoreID" value="STORE_ID">
  <input name="token" value="API_TOKEN">
  <input name="cmd" value="OMN">
  <input name="OrdersData" value="{...JSON...}">
</form>

{
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "orders": [
    {
      "cmd": "update",
      "order": { "number": "ORDER_NUMBER", "status": "Approved" }
    }
  ]
}

As opções globais podem disparar webhook, sincronização de marketplaces, sincronização entre lojas ou atualização de estoque. Escolha cada uma conscientemente. Em update, envie somente os campos obrigatórios e os campos que serão alterados; a alteração de itens não é contrato confirmado.

A resposta pode conter order_1, order_2, received, valid, invalid, inserted, updated, err e errDescr. ErrProcessingOrders indica processamento parcial: confira cada pedido retornado.

12.1 - Estrutura completa e retornos de pedidos

Estrutura do JSON:

Para inclusão o comando (cmd) dentro de cada registro do array "orders" deve ser insert e para atualização update. Para alteração devem ser enviados somente os campos que tiverem alterações, não é necessário enviar todos os campos.

                
{
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "orders": [
    {
      "cmd": "insert/update",
      "order": {
        "number": "165240550",
        "ref_number": "MYNUMBER00001",
        "transaction_status": "WAITING PAYMENT",
        "payment_status": "PENDING",
        "custom_data": "Informações personalizadas",
        "invoice": "111111111111111111111",
        "amount_without_shipping": 31.5,
        "coupon_discount": 0,
        "discount_without_shipping": 10,
        "short_obs": "OBS CURTA",
        "status": "New"
      },
      "customer": {
        "name": "Nome da pessoa",
        "gender": "male",
        "birth_date": "1978-01-01T03:00:00Z",
        "email": "cliente@example.test",
        "phone": "(21) 5555-1234",
        "cellphone": "11988886666",
        "custom_1": "info 1",
        "custom_2": "info 2",
        "custom_3": "info 3",
        "document": {
          "type": "CPF",
          "number": "01234567890"
        },
        "additional_document": {
          "type": "RG",
          "number": "1111111111"
        },
        "address": {
          "country": "Brasil",
          "street": "Rua Sete de Setembro",
          "street_number": "123",
          "complement": "Comp1",
          "neighborhood": "Centro Casa",
          "city": "Rio de Janeiro",
          "state": "RJ",
          "zipcode": "20050-001"
        }
      },
      "payment": {
        "method": "Cartão de Crédito",
        "processed_by": "Pagar.me",
        "brand": "VISA",
        "installments": 3,
        "interest": 0
      },
      "shipping": {
        "name": "Nome destinatário",
        "email": "destino@example.test",
        "amount": 10.5,
        "amount_packaging": 0,
        "custom_1": "info 1",
        "custom_2": "info 2",
        "custom_3": "info 3",
        "discount": 0,
        "message": "Mensagem do cliente",
        "gift": false,
        "phone": "(21) 2222-2222",
        "info": "CEP 04516-001 (SEDEX 10)",
        "obs": "3 dias",
        "tracking_code": "SDX00011",
        "delivery_date": "",
        "address": {
          "country": "Brasil",
          "street": "Rua Sete de Setembro",
          "street_number": "123",
          "complement": "comple",
          "neighborhood": "Centro Casa",
          "city": "Rio de Janeiro",
          "state": "RJ",
          "zipcode": "20050-001"
        }
      },
      "items": [
        {
          "id": 170070,
          "sku_code": "111",
          "name": "Camiseta",
          "category_name": "Moda",
          "bar_code": null,
          "descriptor_1": null,
          "descriptor_2": "P",
          "descriptor_3": null,
          "simple_descriptor_1": null,
          "simple_descriptor_2": null,
          "simple_descriptor_3": null,
          "color": "Branco",
          "filters": null,
          "unit_price": 11,
          "quantity": 1,
          "weight": 12000
        },
        {
          "id": 170071,
          "sku_code": "222",
          "name": "Camiseta",
          "category_name": "Moda",
          "bar_code": null,
          "descriptor_1": null,
          "descriptor_2": "M",
          "descriptor_3": null,
          "simple_descriptor_1": null,
          "simple_descriptor_2": null,
          "simple_descriptor_3": null,
          "color": "Branco",
          "filters": null,
          "unit_price": 12,
          "quantity": 2,
          "weight": 0
        }
      ]
    }
  ]
}
                
              

É possível incluir/alterar múltiplos pedidos por vez.

O resultado desta operação será retornado em JSON. Segue o modelo:

                
{
  "begin": "2025-01-16T20:08:02-03:00",
  "srv": "serverName",
  "cmd": "OMN",
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "order_1": {
    "cmd": "insert",
    "ref_number": "MYNUMBER00001",
    "shipping_amount": 10.5,
    "order_totalItems": 35,
    "order_amount_without_shipping": 31.5,
    "order_totalAmount": 42,
    "customer_id": 2449,
    "customer_updated": true,
    "customer_inserted": false,
    "order_updated": false,
    "order_inserted": true,
    "order_id": 6240,
    "order_number": 165240724,
    "items_1": "OK: inserted [170070]",
    "items_2": "OK: inserted [170071]",
    "err": "OK"
  },
  "received": 1,
  "valid": 1,
  "invalid": 0,
  "inserted": 1,
  "updated": 0,
  "sess": "173403027",
  "end": "2025-01-16T20:08:02-03:00",
  "et": 200
}
                
              

Obs: Note que o order_number gerado automaticamente pelo sistema é retornado neste JSON.

Veja a lista com os possíveis códigos de erros (<err>) e suas descrições (<errDescr>):

Se houver erros, o resultado desta operação será retornado em JSON da seguinte forma:

{
  "begin": "2025-01-16T20:10:45-03:00",
  "srv": "dom0web7",
  "cmd": "OMN",
  "err": "ErrOrderManagementInvData",
  "errDescr": "Invalid OrderData",
  "sess": "173403027",
  "end": "2025-01-16T20:10:45-03:00",
  "et": 32
}
              

{
  "begin": "2025-01-16T20:12:36-03:00",
  "srv": "dom0web7",
  "cmd": "OMN",
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "order_1": {
    "cmd": "update",
    "order_number": 1652405501,
    "ref_number": "MYNUMBER00001",
    "shipping_amount": 10.5,
    "order_amount_without_shipping": 31.5,
    "order_totalAmount": 42,
    "err": "order.number not found"
  },
  "order_2": {
    "cmd": "update",
    "order_number": 165240551,
    "ref_number": "MYNUMBER00001",
    "shipping_amount": 10.5,
    "order_amount_without_shipping": 31.5,
    "order_totalAmount": 42,
    "customer_id": 2433,
    "customer_updated": true,
    "customer_inserted": false,
    "order_updated": true,
    "order_inserted": false,
    "order_id": 6060,
    "err": "OK"
  },
  "received": 2,
  "valid": 1,
  "invalid": 1,
  "inserted": 0,
  "updated": 1,
  "err": "ErrProcessingOrders",
  "errDescr": "An error occurred in one or more records",
  "sess": "173403027",
  "end": "2025-01-16T20:12:36-03:00",
  "et": 104
}
              

Sempre serão retornados os registros e indicado em cada registro se ocorreu ou não erro ao processar aquele registro.

Outras informações do retorno:

13 - Realizando Testes

Disponibilizamos uma página para facilitar a realização de testes de integração via navegador e assim conhecer melhor o funcionamento da API. Segue o endereço:

API Test

13.1 - Comando LIN

Neste teste, será possível ver o processo para fazer login e obter token para as requisições da API.

No campo Cmd selecione a opção Login (LIN). Preencha os campos e clique em Entrar.

Campos retornados pela API:

Como resultado, teremos a seguinte estrutura:

{
  "begin": "2025-01-17T18:09:43-03:00",
  "srv": "dom0web7",
  "cmd": "LIN",
  "id": 184,
  "st": "STORE_NAME",
  "usr": "API_USERNAME",
  "err": "ErrOK",
  "errDescr": "OK",
  "sess": "179662158",
  "tk": "API_TOKEN",
  "end": "2025-01-17T18:09:43-03:00",
  "et": 16
}
              

13.2 - Comando OMN

Neste teste, serão alterados dois pedidos da loja de testes. Substitua os números ilustrativos por pedidos dessa loja. As opções de webhook, sincronização e estoque estão desativadas nos exemplos; habilite cada uma somente quando fizer parte do teste planejado.

No campo Cmd selecione a opção OMN. Preencha os campos IDLoja, Token e no campo OrdersData informe o JSON com os registros que deseja alterar e clique em Entrar.

Exemplo

{
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "orders": [
    {
      "cmd": "update",
      "order": {
        "number": "165240550",
        "status": "New"
      }
    },
    {
      "cmd": "update",
      "order": {
        "number": "165240551",
        "status": "Approved"
      }
    }
  ]
}
              

Como resultado, teremos a seguinte estrutura:

{
  "begin": "2025-01-17T18:25:22-03:00",
  "srv": "dom0web7",
  "cmd": "OMN",
  "send-webhook-notifications": false,
  "sync-marketplaces": false,
  "sync-stores": false,
  "manage-stock": false,
  "accept-only-store-products": true,
  "order_1": {
    "cmd": "update",
    "order_number": 165240550,
    "customer_inserted": false,
    "customer_updated": false,
    "customer_id": 2433,
    "order_updated": true,
    "order_inserted": false,
    "order_id": 6059,
    "err": "OK"
  },
  "order_2": {
    "cmd": "update",
    "order_number": 165240551,
    "customer_inserted": false,
    "customer_updated": false,
    "customer_id": 2433,
    "order_updated": true,
    "order_inserted": false,
    "order_id": 6060,
    "err": "OK"
  },
  "received": 2,
  "valid": 2,
  "invalid": 0,
  "inserted": 0,
  "updated": 2,
  "err": "ErrOK",
  "errDescr": "OK",
  "sess": "179662158",
  "end": "2025-01-17T18:25:22-03:00",
  "et": 124
}
              

13.3 - HLP: descobrir campos e ações

Envie ao endpoint https://www.rumo.com.br/adm/Adm360.ehc:

cmd=HLP
StoreID=STORE_ID
token=API_TOKEN
table=news

Conferir: o retorno tableHelp, os campos de leitura e as ações liberadas para news. Se houver permissão de exclusão, confira deleteByID. Repita omitindo table para consultar a ajuda disponível. Ausência de uma ação pode decorrer da permissão ou de a tabela não oferecer a operação.

13.4 - REG: leitura e ciclo de cadastro

Comece com uma leitura de notícias:

cmd=REG
StoreID=STORE_ID
token=API_TOKEN
actions=[{"a":"r","t":"news","out":["id","title","date","enable"],"page":1,"pageSize":20}]

Conferir: resultado individual da ação e registros retornados. Uma lista vazia não representa falha. Para exercitar escrita, use uma loja de testes e um registro criado exclusivamente para esse teste, com as permissões da matriz REG.

Mantenha cmd=REG, StoreID e token. Em chamadas separadas, substitua o campo actions pelos exemplos a seguir.

Incluir uma notícia desativada:

[{"a":"i","t":"news","f":[["title","Teste de integracao ADM360"],["body","Conteudo ficticio para teste."],["enable",false]]}]

Anote o id devolvido pela ação de inclusão. Nos próximos exemplos, 123 é apenas um número ilustrativo: substitua-o pelo ID realmente criado neste teste.

Alterar e ler para conferir:

[{"a":"u","t":"news","id":123,"f":[["title","Teste de integracao revisado"]]}]

[{"a":"r","t":"news","id":123,"out":["id","title","enable"]}]

Excluir somente o registro criado para teste:

[{"a":"d","t":"news","id":123}]

Conferir: sucesso de cada ação e ausência do registro após a exclusão. Não reutilize um ID preexistente da loja. O erro geral ErrOK não dispensa a leitura dos resultados individuais.

13.5 - REL: descobrir e executar um relatório

Primeiro consulte o catálogo de relatórios por REG:

cmd=REG
StoreID=STORE_ID
token=API_TOKEN
actions=[{"a":"r","t":"reportUtilities","f":[["utilities",false]],"out":["id","name","type","description","parName1","parType1","parSize1"]}]

Escolha um objeto retornado para o usuário e consulte seus parâmetros parName1..8, parType1..8 e parSize1..8, acrescentando os campos necessários a out. Substitua REPORT_ID pelo ID escolhido:

cmd=REL
StoreID=STORE_ID
token=API_TOKEN
ObjectID=REPORT_ID
Page=1
QtRecords=20

Se o objeto exigir parâmetros, acrescente Par1 até Par8 conforme o catálogo. Não envie parâmetros fictícios nem assuma que todos os relatórios aceitam os mesmos valores.

Conferir: erro geral, identificação do relatório, dados e metadados retornados. Teste Page=2 mantendo o restante dos campos. Em resultado vazio, alguns metadados podem não aparecer.

13.6 - UTL: selecionar e testar um utilitário

Consulte o catálogo de utilitários autorizados:

cmd=REG
StoreID=STORE_ID
token=API_TOKEN
actions=[{"a":"r","t":"reportUtilities","f":[["utilities",true]],"out":["id","name","type","description","parName1","parType1","parSize1"]}]

Leia a descrição e todos os parâmetros do objeto escolhido. Este próximo passo pode alterar dados: escolha um utilitário apropriado à loja de testes e confirme seu efeito antes de enviar.

cmd=UTL
StoreID=STORE_ID
token=API_TOKEN
ObjectID=UTILITY_ID

Substitua UTILITY_ID e acrescente apenas os parâmetros Par1..8 exigidos pelo objeto. Não há um utilitário universal nem um modo de simulação implícito neste exemplo.

Conferir: retorno e efeito específicos do utilitário. Alguns geram arquivo ou redirecionamento. Em timeout ou resposta inesperada, confira o resultado na loja antes de repetir a operação.

13.7 - FMG: listar e criar uma pasta de teste

Com permissão de Alteração em Design, liste a área HTML:

cmd=FMG
StoreID=STORE_ID
token=API_TOKEN
Operation=list
path=htm
page=1
pageSize=20

Conferir: path, folderList, fileList e informações de paginação. Com acesso somente a Produtos, envie path vazio para listar a base prod; o caminho é relativo à área liberada.

Para testar criação, confirme antes que a pasta testeapi não existe. Use outro nome exclusivo se necessário:

cmd=FMG
StoreID=STORE_ID
token=API_TOKEN
Operation=create
path=htm
folderName=testeapi

Conferir: retorno sem erro e presença da pasta em uma nova listagem de htm. O teste de upload abaixo pode utilizar essa pasta. Não remova pastas que já existiam antes do teste.

13.8 - UPL: enviar um arquivo de teste

Crie localmente um pequeno arquivo testeapi.htm contendo apenas um parágrafo de teste. Para este exemplo, use Alteração em Design e a pasta htm/testeapi criada no item anterior. Configure uma chamada POST multipart para https://www.rumo.com.br/adm/Adm360UploadExec.asp.

Omita Overwrite0 para não sobrescrever. Não envie a string false, pois um valor preenchido pode ativar a sobrescrita. Deixe o cliente HTTP gerar o cabeçalho multipart com seu delimitador (boundary); não envie o arquivo como texto de formulário comum.

Conferir: resultado do upload e presença de testeapi.htm em uma listagem FMG de htm/testeapi. Para limpar somente o arquivo criado neste teste:

cmd=FMG
StoreID=STORE_ID
token=API_TOKEN
Operation=delete
path=htm/testeapi
items=["testeapi.htm"]

Depois de confirmar que a pasta está vazia e foi criada por você neste teste, remova-a com Operation=delete, path=htm e items=["testeapi"]. Confira o retorno individual da operação.

13.9 - LOU: encerrar a sessão

Execute por último, após concluir os demais testes:

cmd=LOU
StoreID=STORE_ID
token=API_TOKEN

Conferir: retorno ErrOK. Uma chamada autenticada posterior com o token encerrado deve ser recusada; descarte o token e faça um novo LIN para continuar. Não grave seu valor nos registros de teste.

14 - Dicionário de Dados

14.1 - Order Management [Comando OMN]

JSON de API de pedidos [Inclusão/Alteração]

15 - Tratamento de Erros

As respostas usam err e errDescr para informar o resultado geral. O envelope pode incluir begin, srv, cmd, sess, end e et.

{
  "err": "ErrOK",
  "errDescr": "OK"
}

• Não grave senha, token, OTP ou dados pessoais em logs.
• Use somente HTTPS e um usuário exclusivo para cada aplicação.
• Em operações de escrita, implemente timeout, retentativa limitada e conciliação antes de reenviar.
• Teste em loja autorizada e mantenha trilha de auditoria de alterações.

Os erros são retornados em "err" e "errDescr" respectivamente.

No exemplo o retorno aponta que não ocorreram erros:

  "err": "ErrOK",
  "errDescr": "OK",
              

Exemplo de retorno da API quando ocorre erro:

  "err": "ErrOrderManagementInvData",
  "errDescr": "Invalid OrderData",