Skip to content

Observações importantes

1. Base URL

EnvironmentAddress
Productionhttps://openapi.fastmoss.com

2. Método de solicitação

Todas as solicitações de API usam o método POST.

3. Formato de resposta

Todas as respostas da API são retornadas no formato JSON object. O campo data contém os dados específicos, que são um Json object.

Nome do parâmetroTipoDescrição
codeintegerCódigo de status
msgstringMensagem
dataobjectDados
request_idstringID da solicitação
timestamptimestamp[integer]Timestamp do servidor

Exemplo

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "xxx": "xxx"
    },
    "request_id": "xxxx",
    "timestamp": 1690351112
}

4. Relação entre HTTP Status Code e Code

  • HTTP Status Code e Code não entram em conflito.
  • Code representa o código de status específico do negócio.
  • Verifique primeiro o HTTP Status Code e depois o Code.
  • Quando o HTTP Status Code for 200 e o Code for 0, isso indica sucesso.

Descrição do código de status

Código de statusTipoDescrição
0Sem exceçãoSucesso
10001Erro de parâmetroO parâmetro não atende aos requisitos
20001Erro de dadosRecurso não encontrado
30001Erro de permissãoSem permissão de acesso
30002Erro de permissãoLimite de dados excedido
30003Erro de permissãoFrequência de acesso excedida
40001Erro de serviçoExceção de serviço