Obter um Token de Acesso (API Key)

Um token de acesso é uma chave de autenticação que permite a um usuário ou aplicação acessar a API da Jusbrasil. Cada usuário tem um token de acesso único, que deve ser incluído em todas as requisições feitas à API. Esse token pode ser usado infinitamente, a menos que seja re-gerado. Caso for re-gerado, o token antigo ficará invalidado e deve se usar apenas o novo token retonado.

Re-gerar um novo token de acesso de usuário

Para poder gerar um token de acesso de um usuário é necessário se autenticar com o token de um administrador da empresa à qual o usuário pertence ou um token de um usuário da empresa-mãe.

Nota

Se já tiver um token de acesso, não é necessário essa etapa, já que o mesmo tem duração permanente.

curl -X POST 'https://op.digesto.com.br/api/admin/user/<id>/reset_api_token' \

Parâmetro	Tipo	Descrição
id	int	ID do usuário.

Exemplo de chamada:

cURL

curl -X POST 'https://op.digesto.com.br/api/admin/user/5/reset_api_token' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Resposta

{
    "$uri": "/api/admin/user/5",
    "api_key": "0bb5e3a5-cd56-46c1-8552-061839f07",
    "archived_at": null,
    "created_at": {
        "$date": 1509126090000
    },
    "email": "local2@teste.com.br",
    "is_autogenerated": false,
    "is_new_password": false,
    "last_login_at": {
        "$date": 1509126176000
    },
    "last_pw_change_at": null,
    "name": "teste usuario local",
    "roles": [
        "proc.monitorar",
        "companyadmin"
    ],
    "user_company": {
        "$ref": "/api/admin/user_company/1"
    },
    "user_company_id": 1,
    "user_creator_id": 3
}

Parâmetro	Tipo	Descrição
api_key	str	Token de acesso gerado.
email	str	E-mail do usuário.
name	str	Nome do usuário.

Nota

O token de acesso não pode ser modificado após gerado, apenas re-gerado.

Recuperar um token de acesso de usuário administrador

Para poder recuperar o token de acesso de um usuário administrador é necessário se autenticar com o token de um usuário da empresa-mãe.

curl -X GET 'https://op.digesto.com.br/api/admin/user_company/<id>/admin_api_token' \

Parâmetro	Tipo	Descrição
id	int	ID da empresa.

Exemplo de chamada:

cURL

curl -X GET 'https://op.digesto.com.br/api/admin/user_company/1/admin_api_token' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
    "api_key": "21357b41-f22d-4a09-8bc1-71042936b624",
    "status": "OK"
}

Parâmetro	Tipo	Descrição
api_key	str	Token de acesso gerado.
status	str	Status da requisição.

Nota

Caso não exista um usuário administrador definido para essa empresa, um novo aleatório será criado após a chamada.

Aviso

Caso a empresa-mãe for a Digesto ou Jusbrasil, por favor entre em contato com o suporte.