Serviço de listagem de lojas
Após obter o token ou assinatura na etapa anterior, a loja virtual pode consumir o serviço de listagem de lojas.
Detalhes da chamada
- Recurso:
/v1/merchants
- Método HTTP:
GET
- Formato da requisição:
query string
- Formato da resposta:
JSON
- Parâmetros de cabeçalho:
Parâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
merchant_id | Código da loja no e-SiTef. Os códigos de produção e certificação serão diferentes. | < 15 AN | SIM |
merchant_key | Chave de autenticação da loja no e-SiTef. As chaves de produção e certificação serão diferentes. | < 80 AN | SIM |
token | Token obtido no serviço de criação de token. Saiba mais. | = 66 AN | NÃO |
Authorization | Deve ser enviada a assinatura de autenticação da loja no formato Bearer {assinatura} . Exemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg . Saiba mais. | < 2000 AN | NÃO |
Exemplo
Abaixo estão alguns exemplos da chamada do serviço de listagem de loja utilizando a ferramenta cURL.
Listagem de loja utilizando token
Requisição:
curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--verbose
Listagem de loja utilizando assinatura
Requisição:
curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants?cnpj=12345678901234&merchant_status=A&page=1&limit=1"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer YYYYYYY"
--verbose
Resposta:
{
"response_code":"0",
"response_message":"OK",
"current_page":"0",
"total_pages":"1",
"count":"1",
"merchants":[
{
"id":"qereIoinsd3d",
"merchant_status":"A",
"fantasy_name":"Teste de Loja",
"corporate_name":"Testes de Loja Ltda.",
"cnpj":"12345678901234"
}
]
}
Parâmetros de requisição
Parâmetro | Descrição | Formato | Obrigatório |
---|---|---|---|
cnpj | CNPJ da loja. | = 14 N | NÃO |
merchant_status | Status da loja. Pode assumir os seguintes valores:
| = 1 AN | NÃO |
page | Página da listagem. A primeira página tem valor 0 . Caso não seja enviada, assumiremos o valor 0 . | < 4 N | NÃO |
limit | Número máximo de registros por página. Caso não seja enviado, assumiremos o valor máximo 100. | < 3 N | NÃO |
Parâmetros de resposta
Em caso de sucesso, o código de resposta HTTP será 200
. Qualquer outro código deve ser interpretado como erro.
Parâmetro | Descrição | Formato |
---|---|---|
response_code | Código de resposta do e-SiTef. | < 4 N |
response_message | Mensagem de resposta do e-SiTef. | < 500 AN |
current_page | Página atual dos registros. | < 4 N |
total_pages | Número total de páginas. | < 4 N |
count | Contagem total de registros. | < 4 N |
merchants[] | Lista de lojas retornada na consulta. | |
id | Código da loja consultada. | < 15 AN |
merchant_status | Status da loja. Pode assumir os seguintes valores:
| = 1 AN |
fantasy_name | Nome fantasia da loja. | < 250 AN |
corporate_name | Razão social da loja. | < 250 AN |
cnpj | CNPJ ou CPF da loja. Apenas números. | < 14 N |