Skip to main content

Cadastro de credenciado

Adiciona registro de credenciado na garagem. O registro de credenciado, para ser efetivado, depende dos parâmetros “código da mensalidade”, “código do vencimento”, “códigos dos pátios habilitados” e “grupo”, que não estão presentes nesse serviço, portanto, não são passados na requisição. Esses parâmetros são definidos dentro da plataforma i e seus valores são utilizados para todos os credenciados cadastrados através desse serviço.

POST api/integradores/credenciados

HEADERS

CHAVE
 VALOR
 DESCRIÇÃO
 OBRIGATÓRIO
Accept
 application/vnd.linkc.com.br; version=1 Versão da API. SIM
Authorization
 Bearer <TOKEN>
 Token obtido na autenticação
 SIM
Content-Type
 application/json
 Tipo de conteúdo do request
 SIM

PARÂMETROS (BODY)

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO

tipo

“MEN” para mensalista, “AUT” para autorizado. Caso o credenciado seja mensalista ele será associado à mensalidade e vencimento préconfigurados na plataforma.

 SIM

nome

Nome do credenciado, até 50 caracteres.

 SIM

documento

Documento do credenciado, até 12 caracteres.

NÃO

cpf

CPF do credenciado.

NÃO

qtd_vagas

Quantidade de vagas que o credenciado tem direito de utilizar simultaneamente. Caso o parâmetro não seja informado, será cadastrado o valor 1.

NÃO

telefone

Telefone do credenciado, até 15 caracteres.

NÃO

mensalidade_id

Código da mensalidade, esse valor de ser consultado na chamada api/integradores/mesalidades, caso não seja informado, iremos cadastrar com o valor padrão cadastrado para a garagem.

NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
id

Código do credenciado gerado na garagem.

nome

Nome do credenciado.

documento

Documento do credenciado.

cpf

CPF do credenciado.

tipo

Tipo do credenciado.

qtd_vagas

Quantidade de vagas do credenciado.

telefone

Telefone do credenciado.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "credenciado": {
        "id": "123456",
        "nome": "MARIA VITÓRIA OLIVEIRA",
        "documento": "12.345.678-X",
        "cpf": "64454846626",
        "tipo": "MEN",
        "qtd_vagas": 1,
        "telefone": "(19) 987654321"
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
400
 Caso os parâmetros passados estejam incorretos.
401
 Caso as credenciais sejam inválidas.

502

Caso não seja possível realizar comunicação com a automação da garagem.

Back to top