Authentication

Click here to access your API Key.

Base URL: {{baseURL}}

Header	Value	Required	Default
AnalisadorNeural-API-Key	API Key	YES
AnalisadorNeural-API-Locale	pt-BR or en	NO	pt-BR
AnalisadorNeural-API-Version	1	NO	1
Content-Type	application/json	No	application/json

Ex.:

{
  "AnalisadorNeural-API-Key": "{{APIKey}}",
  "AnalisadorNeural-API-Locale": "{{APILocale}}",
  "AnalisadorNeural-API-Version": {{APIVersion}},
  "Content-Type": "application/json"
}

Status code

Success: 2××
Client error: 4××
Server error: 5××

Errors

Status code response body ex.:

401 Unauthorized

{
  "errors": {
    "api": {
      "version": "API Version is not valid.",
      "locale": "API Locale is not valid.",
      "key": "API Key is not valid."
    }
  }
}

404 Not Found:

{
  "status": 404,
  "error": "Not Found"
}

422 Unprocessable Entity:

{
  "errors": {
    "field": ["message", "message"]
  }
}

500 Internal Server Error:

{
  "status": 500,
  "error": "Internal Server Error"
}

Ping

GET /

Request ex.:

{
  "headers": {
    "AnalisadorNeural-API-Key": "{{APIKey}}",
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "GET",
  "url": "/"
}

Response ex.:

{
  "api": {
    "key": "{{APIKey}}",
    "locale": "{{APILocale}}",
    "version": {{APIVersion}}
  }
}

Playground

Edit and click send.

{
  "headers": {
    "AnalisadorNeural-API-Key": null,
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "GET",
  "url": "/"
}

Response: {{lastStatus.ping}}

Timezone

Brasilia

"

Attendances

List attendance configurations to register a new attendance:

PATCH or GET /configuracoes-atendimentos
Filter: configuracao-atendimento

Attribute	Required	Format	Default	Valid
ordenar	No	Texto	id	id, nome, data_hora_criacao
ordem	No	Texto	asc	asc, desc
nome	No	Texto
data_hora_criacao_inicial	No	YYYY-MM-DDThh:mm:ss
data_hora_criacao_final	No	YYYY-MM-DDThh:mm:ss

Request ex.:

{
  "headers": {
    "AnalisadorNeural-API-Key": "{{APIKey}}",
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "PATCH",
  "url": "/configuracoes-atendimentos",
  "data": {
    "configuracao_atendimento": {
      "ordenar": "id",
      "ordem": "asc",
      "nome": "Nome",
      "data_hora_criacao_inicial": "2000-01-01T00:00:00",
      "data_hora_criacao_final": "2000-01-01T00:00:00"
    }
  }
}

Response ex.:

{
  "configuracoes_atendimentos": [
    {
      "id": 0,
      "nome": "Nome",
      "data_hora_criacao": "2000-01-01T00:00:00"
    }
  ]
}

Playground

Edit and click send.

{
  "headers": {
    "AnalisadorNeural-API-Key": null,
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "PATCH",
  "url": "/configuracoes-atendimentos",
  "data": {
    "configuracao_atendimento": {
      "ordenar": null,
      "ordem": null,
      "nome": null,
      "data_hora_criacao_inicial": null,
      "data_hora_criacao_final": null
    }
  }
}

Response: {{lastStatus.attendances}}

Show fields to register a new attendance:

GET /configuracoes-atendimentos/ID/atendimentos/novo

Request ex.:

{
  "headers": {
    "AnalisadorNeural-API-Key": "{{APIKey}}",
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "GET",
  "url": "/configuracoes-atendimentos/0/atendimentos/novo"
}

Response ex.:

{
  "id_0": {
    "nome": "Nome",
    "descricao": "Descrição",
    "sessao": "Sessão",
    "obrigatorio": true,
    ...
    "tipo": "caractere",                              // Or: data, hora, lógico, numérico.
    ...
    "tamanho": 10,                                    // When it is caractere and numérico.
    "decimais": 2,                                    // When it is numérico and not inteiro.
    "inteiro": true,                                  // When it is numérico.
    ...
    "valores": ["Valor A", "Valor B"],                // When it is caractere.
    "valores": ["2018-02-02", "2018-10-10"],          // When it is data.
    "valores": ["01:01", "20:20"],                    // When it is hora.
    "valores": [11, 22],                              // When it is numérico and inteiro.
    "valores": [1.11, 2.22],                          // When it is numérico and not inteiro.
    ...
    "minimo": "2018-01-31",                           // When it is data and have no valores.
    "minimo": "01:00",                                // When it is hora and have no valores.
    "minimo": 0,                                      // When it is numérico, inteiro and have no valores.
    "minimo": 1.11,                                   // When it is numérico, not inteiro and have no valores.
    ...
    "maximo": "2018-11-31",                           // When it is data and have no valores.
    "maximo": "22:59",                                // When it is hora and have no valores.
    "maximo": 99,                                     // When it is numérico and inteiro and have no valores.
    "maximo": 9.99                                    // When it is numérico and not inteiro and have no valores.
  }
}

Playground

Edit and click send.

{
  "headers": {
    "AnalisadorNeural-API-Key": null,
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "GET",
  "url": "/configuracoes-atendimentos/ID/atendimentos/novo"
}

Response: {{lastStatus.attendances_new}}

Register a new attendance:

POST /configuracoes-atendimentos/ID/atendimentos

Request ex.:

{
  "headers": {
    "AnalisadorNeural-API-Key": "{{APIKey}}",
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "POST",
  "url": "/configuracoes-atendimentos/0/atendimentos",
  "data": {
    "atendimento": {
      "id_0": "Valor"
    }
  }
}

Response ex.:

{
  "atendimento": {
    "id_0": [
      {
        "porcentagem": 66.66,
        "valor": "Valor B",
        "quantidade": 6
      },
      {
        "porcentagem": 22.22,
        "valor": "Valor A",
        "quantidade": 2
      }
      {
        "porcentagem": 11.11,
        "valor": "Valor C",
        "quantidade": 1
      }
    ]
  }
}

Playground

Edit and click send.

{
  "headers": {
    "AnalisadorNeural-API-Key": null,
    "AnalisadorNeural-API-Locale": "{{APILocale}}",
    "AnalisadorNeural-API-Version": {{APIVersion}},
    "Content-Type": "application/json"
  },
  "baseURL": "{{baseURL}}",
  "method": "POST",
  "url": "/configuracoes-atendimentos/ID/atendimentos",
  "data": {
    "atendimento": {
    }
  }
}

Response: {{lastStatus.attendances_create}}

Analisador Neural

API Version 1

Playground

Playground

Playground

Playground