Faciledoc - API Docs
  1. DataLens
Faciledoc - API Docs
  • Apresentação
    • Autenticação
    • Verificar status da conta
      GET
  • V1
    • DataLens
      • Estrutura de respostas
      • CNPJ Cadastral
        POST
      • CNPJ Sintegra
        POST
      • CNPJ Sócios
        POST
      • CPF Cadastral
        POST
      • Buscar Análise
        GET
  1. DataLens

Estrutura de respostas

Abaixo segue as estruturas de respostas que atendem todos os produtos Datalens:
ERRO - Requisição solicitada com erro na estrutura de dados
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 400,
    'req_msg': 'Erro na estrutura de dados enviada.',
}
ERRO - Requisição solicitada com erro nos campos obrigatórios
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 400,
    'req_msg': string, # mensagem referente a campos obrigatórios
}
SUCESSO - Rotas de solicitação de análise - Análise efetuada com sucesso
{
    'api_versao': 'v1',
    'req_data': datetime,
    'req_status': 200,
    'req_mensagem': 'OK',
    'dados': {
        'produto': string, # Produto selecionado de acordo com a url da API
        'id_analise': int,
        'link': string, # url da consulta para o resultado da análise
    }
}
SUCESSO - Rota de busca de análise - Análise concluída
{
    "api_versao": "v1",
    "req_data": datetime,
    "req_status": 200,
    "req_msg": "OK",
    "dados": {
        "status_analise": 'Concluído',
        "produto": string, # Nome do produto de acordo com o 'id_analise'
        "res_datalens": [], # Estrutura de resposta específica de cada produto DataLens
    }
}
Página anterior
DataLens
Próxima página
CNPJ Cadastral
Built with