Enviar Faturas para Análise

Para a melhor performance da validação automática em relação à qualidade de imagem, os parâmetros de tamanho da imagem devem seguir os requisitos:

• tamanho mínimo: 100KB
• tamanho máximo: 10MB
• extensões: JPEG, PNG, PDF

Requisição

POST [Url Ambiente]/Energia/ProcessarAsync

Header

Identificador	Valor
Content-type	application/json
Accept	application/json
Token	Bearer [Valor do Token retornado na Autenticação]

Body

Parâmetro	Descrição	Tipo	Exemplos	Obrigatório
Chave	Campo para identificação da analise	String	"ChaveDefinidaPeloCliente"	Sim
Cpf	Cpf para identificação	String	"12345678911"	Não
Uf	Uf para identificação	String	"SP"	Não
Distribuidora	Distribuidora para identificação	String	"cpfl paulista"	Não
ImagensBase64	Imagens das faturas	Array de Strings Base64	["Base64Image1", "Base64Image2"]	Sim
Senha	Senha para abrir o arquivo de imagem, quando PDF	String	"Senha123"	Não
Webhook.Url	URL do webhook	String	"https://meu-webhook.com"	Não
Webhook.Headers.additionalProp1	Header adicional do webhook 1	String	"application/json"	Não
Webhook.Headers.additionalProp2	Header adicional do webhook 2	String	"bearer"	Não
Webhook.Headers.additionalProp3	Header adicional do webhook 3	String	"outro-valor"	Não

Exemplo

{
  "Chave": "string",
  "Cpf": "string",
  "Uf": "string",
  "Distribuidora": "string",
  "ImagensBase64": [
    "string"
  ],
  "Senha": "string",
  "WebHook": {
    "Url": "string",
    "Headers": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
}

Status Code 200

Retorno de sucesso.

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Status da requisição	Int	200
Message	Descrição da requisição	Object	{"TypeMessage":"200","Message":"succeeded"}

Exemplo

{
    "StatusCode": 200,
    "Message": {
        "TypeMessage": "200",
        "Message": "succeeded"
    }
}

Status Code 401

Usuário/Senha inválidos.

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Status da requisição	Int	401
Message	Descrição da requisição	Object	{"TypeMessage":"401","Message":"Credenciais inválidas"}

Exemplo

{
    "StatusCode": 401,
    "Message": {
        "TypeMessage": "401",
        "Message": "Credenciais inválidas"
    }
}

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

Parâmetro	Descrição	Tipo	Exemplos
StatusCode	Status da requisição	Int	500
Message	Descrição da requisição	Object	{"TypeMessage":"500","Message":"ERRO NO SERVIDOR"}

Exemplo

{
    "StatusCode": 500,
    "Message": {
        "TypeMessage": "500",
        "Message": "ERRO NO SERVIDOR"
    }
}