Apresentação
Rota básica
https://www.faciledoc.com.br/api
Retorno de erros
| status | mensagem |
|---|---|
| 400 | Sem preenchimento de parâmetro obrigatório |
| 400 | Erro no formato do parâmetro |
| 401 | O Token de acesso não foi fornecido |
| 401 | A conta não está ativa |
| 402 | Saldo insuficiente |
| 403 | O Token é inválido |
| 403 | O plano não permite acessar o produto |
| 404 | Objeto não encontrado |
| 405 | Método não permitido |
Padrão da estrutura de resposta
{
"api_versao": string,
"req_data": datetime,
"req_status": inte, # código do erro
"req_msg": string, # descrição do erro
}{
'api_versao': string,
'req_data': datetime,
'req_status': int,
'req_msg': string,
'dados': [], # a estrutura da resposta depende do endpoint solicitado.
}Descriação das chaves:
api_versao: versão da api utilizadareq_data: timestamp da requisiçãoreq_status: código do status da requisiçãoreq_msg: texto explicativo sobre o status da respostadados: estrutura específica da resposta do endpoint solicitadoExemplos de respostas:
{
'api_versao': string,
'req_data': datetime,
'req_status': int, # código do status
'req_msg': string, # descrição do status
'dados': [], # a estrutura da resposta depende do endpoint solicitado.
}{
'api_versao': string,
'req_data': datetime,
'req_status': int, # código do erro
'req_msg': string, # descrição do status
}