Skip to content

Latest commit

 

History

History
202 lines (157 loc) · 5.74 KB

autenticacoesResources.md

File metadata and controls

202 lines (157 loc) · 5.74 KB

Recurso: autenticacoes

As autenticações são os serviços de autenticação do Intima.ai para os tribunais. Você pode criar diversas autenticações para diversos tribunais sendo uma autenticação para cada tribunal.

Todas as URIs são relativas a https://app.intima.ai/api/v2

Metodo Requisição HTTP Descrição
consultarPorId GET /autenticacoes/{id} Visualiza uma autenticação
cadastrarNovaAutenticacao POST /autenticacoes Cadastra uma nova autenticação
atualizarAutenticacao PUT /autenticacoes/{autenticacao_id}/atualizar Atualiza uma autenticação
ativarCapturaDeIntimacoesParaAutenticacao PUT /autenticacoes/{autenticacao_id}/intimacoes/ativar Ativa a captura de intimações para uma autenticação
desativarCapturaDeIntimacoesParaAutenticacao PUT /autenticacoes/{autenticacao_id}/intimacoes/desativar Desativa a captura de intimações para uma autenticação

consultarPorId

Parametros

Nome Tipo Descrição Notas
id int é o id referente ao tribunal cadastrado em "Tribunais ativos" no Intima.ai [obrigatório]

Exemplos

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;

try 
{
    $intimaai = new Intimaai('api_token');

    $resultado = $intimaai->autenticacoes->consultarPorId(45217);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

cadastrarNovaAutenticacao

Parametros

Nome Tipo Descrição Notas
autenticacao NovaAutenticacao parametros necessários para a criação de um novo registro [obrigatório]

Exemplos

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;
use Intimaai\Models\NovaAutenticacao;

try 
{
    $intimaai = new Intimaai('api_token');

    $autenticacao = new NovaAutenticacao(1, 1);
    $resultado = $intimaai->autenticacoes->cadastrarNovaAutenticacao($autenticacao);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

atualizarAutenticacao

Parametros

Nome Tipo Descrição Notas
autenticacaoId int é o id referente ao tribunal cadastrado em "Tribunais ativos" no Intima.ai [obrigatório]
atualizarAutenticacao AtualizarAutenticacao parametros necessários para a atualizar uma autenticação [obrigatório]

Exemplos

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;
use Intimaai\Models\AtualizarAutenticacao;

try 
{
    $intimaai = new Intimaai('api_token');

    $atualizarAutenticacao = new AtualizarAutenticacao('190792', 'A', 'PB');
    $resultado = $intimaai->autenticacoes->atualizarAutenticacao(1, $atualizarAutenticacao);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

ativarCapturaDeIntimacoesParaAutenticacao

Parametros

Nome Tipo Descrição Notas
autenticacaoId int é o id referente ao tribunal cadastrado em "Tribunais ativos" no Intima.ai [obrigatório]
ativarAutenticacao AtivarIntimacoesParaAutenticacao parametros necessários para a ativação da captura de intimações [obrigatório]

Exemplos

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;
use Intimaai\Models\AtivarIntimacoesParaAutenticacao;

try 
{
    $intimaai = new Intimaai('api_token');

    $ativarIntimacoes = new AtivarIntimacoesParaAutenticacao(['SEM_PRAZO'], [0, 1], ['06:00']);
    $resultado = $intimaai->autenticacoes->ativarCapturaDeIntimacoesParaAutenticacao(1, $ativarIntimacoes);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

desativarCapturaDeIntimacoesParaAutenticacao

Parametros

Nome Tipo Descrição Notas
autenticacaoId int é o id referente ao tribunal cadastrado em "Tribunais ativos" no Intima.ai [obrigatório]

Exemplos

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;

try 
{
    $intimaai = new Intimaai('api_token');

    $resultado = $intimaai->autenticacoes->desativarCapturaDeIntimacoesParaAutenticacao(1);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

[Voltar ao topo]
[Voltar a lista da API]
[Voltar para o README]