# API's de Operador

Documentação referente as API's de comunicação com o cadastro de Operador.

# Pré-requisitos

O módulo de ACL deve estar na versão 2.24.0 (ou superior).
O menu Parametrização ACL deve estar disponível para sua organização.

# Token

O primeiro passo é criar um token de acesso para utilizar as rotinas na tela Controle de Acesso -> Parametrização ACL, aba Token API.

Nota

É recomendado que apenas usuários administradores possuam acesso à essa tela.

tokenAPI

Crie um novo registro, informando uma descrição para diferenciar seus tokens.
Após criado, copie o valor do token utilizando a ação Copiar Token no final do registro. Essa será a chave necessária para comunicação com as API's.

actCopy

Nota

Será possível criar mais de um token para diferentes aplicações que utilizarão a integração. Gerencie-os do formato que for necessário.

# Dados dos Operadores

Utilize a rota /apiOperador com o método POST para obter os dados dos operadores cadastrados nos sistemas Teknisa.

# Parâmetros:

TOKEN (Obrigatório): Chave criada no passo anterior.
NMOPERADOR (Opcional): Filtro referente ao nome do operador. Filtra os registros pelo valor enviado em qualquer parte do texto.
CDOPERADOR (Opcional): Filtro referente ao código do operador. Filtra os registros com o código igual ao valor enviado.
- É possível enviar um valor único (string) ou um array contendo os códigos (string).
CPF (Opcional): Filtro referente ao CPF do operador. Filtra os registros com o CPF igual ao valor enviado.
- Todos os caracteres não numéricos enviados serão removidos automaticamente.
ATIVO (Opcional): Filtro para retornar apenas operadores ativos ou inativos. Envie "S" para ativos ou "N" para inativos.
CREATED_AT (Opcional): Filtro referente à data de criação do operador. Filtra os registros por um intervalo de datas enviado como um array.
- A primeira posição será a data inicial e a segunda a data final.

# Exemplos

URL: https://produto.teknisa.com/backend_acl/index.php/apiOperador

Parâmetros para requisição que retorna todos os operadores ativos:

{
    "TOKEN": "SEU_TOKEN",
    "ATIVO": "S"
}

Nota

Altere a base do endereço https://produto.teknisa.com para o produto utilizado. O restante, siga o mesmo do link de exemplo.
Informe o token cadastrado no parâmetro TOKEN.

Parâmetros para requisição que retorna todos os operadores criados em janeiro de 2025:

{
    "TOKEN": "SEU_TOKEN",
    "CREATED_AT": [
		"01/01/2025",
		"31/01/2025"
	]
}

O retorno será em formato json contendo as informações:

[
	{
		"NMOPERADOR": "Operador Teste",
		"CDOPERADOR": "000000000123",
		"CPF": null,
		"ATIVO": "S",
		"CREATED_AT": "20/01/2025 14:28:52"
	},
	{
		"NMOPERADOR": "Operador Teste 2",
		"CDOPERADOR": "000000000456",
		"CPF": "12345678911",
		"ATIVO": "N",
		"CREATED_AT": "28/01/2025 13:41:40"
	}
]

# Inativar Operadores

Utilize a rota /apiInativarOperador com o método POST para inativar os operadores cadastrados nos sistemas Teknisa.

# Parâmetros:

TOKEN (Obrigatório): Chave criada no passo anterior.
CDOPERADOR (Obrigatório): Filtro referente ao código do operador. O valor deverá ser um array de strings contendo a lista de operadores a serem inativados.

# Exemplos

URL: https://produto.teknisa.com/backend_acl/index.php/apiInativarOperador

Parâmetros para requisição que retorna todos os operadores ativos:

{
    "TOKEN": "SEU_TOKEN",
    "CDOPERADOR": ["000000000123", "000000000456"]
}

Em caso de sucesso, o retorno será uma string informando a quantidade de operadores que foram encontrados e inativados:

Foram inativados 2 operadores!

# Tratando os erros

Nas API's disponíveis, verifique se a resposta contém a propriedade error. Se algum erro ocorrer, essa propriedade descreverá a razão do problema.

Exemplo de retorno, para casos onde o token não for enviado ou não for válido:

{
	"error": "Token inválido",
	"errorCode": 4
}

Exemplo de retorno, para o caso onde o parâmetro CDOPERADOR é obrigatório:

{
	"error": "O parâmetro CDOPERADOR está vazio ou não foi informado",
	"errorCode": 4
}

← Parametrização Active Directory