README

Intima.ai - SDK PHP

Este repositório é a implementação da API do Intima.ai em forma de SDK Client para PHP. Este SDK cobre todas as ações disponíveis dentro da plataforma do Intima.ai e as disponibilizam como métodos, que podem ser integrados e utilizados por outros serviços ou aplicações, bastando somente possuir o Token de acesso da API (api_token).

Versão da API: 2.0.0
Referência da API: Referência completa da API

Requerimentos

PHP >= 5.5

Instalação

Composer

Para instalar via Composer, faça o seguinte:

composer require brainydigital/intima.ai-sdk-php

E execute o comando composer install

Instalação Manual

Baixe os arquivos e dê o include do autoload.php:

    require_once('/path/to/vendor/autoload.php');

Começando

Os passos necessários para começar a solicitar novas ações dentro do Intima.ai (solicitar cópias processuais, ativar escutas de processos, protocolar e etc) são os seguintes:

Importe um Certificado do tipo A1 para sua conta (você advogado pode solicitar um certificado A1 em qualquer certificadora autorizada) ou utilize login e senha, caso o tribunal dê suporte;
Crie uma Autenticação (serviço de autenticação) para cada Tribunal que você deseja executar Ações;
Agora é só solicitar qualquer tipo de ação que o Intima.ai dê suporte, seguindo as documentações específicas para cada tipo de ação.

Após seguir os passos da instalação e possuir uma autenticação válida para um Tribunal. Por exemplo, para realizar uma nova cópia processual:

<?php

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

use Intimaai\Intimaai;
use Intimaai\API\APIRequestException;
use Intimaai\Models\CopiaProcessual;

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

    $copiaProcessual = new CopiaProcessual('00000000000000000000', 120);
    $resultado = $intimaai->copiasProcessuais->cadastrarNovaCopia($copiaProcessual);
    dump($resultado);
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

Paginando recursos

A maioria dos recursos do SDK possuem paginação, que pode ser acessada atravez da classe Paginator. A utilização da paginação de um recurso é bem simples:

<?php

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

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

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

    $paginacao = $intimaai->copiasProcessuais->paginar();

    $paginacao->obterPagina(1);
    $paginacao->proximaPagina();
    $paginacao->paginaAnterior();
    $paginacao->existeProximaPagina();
    $paginacao->carregarTudo();

    dump($paginacao->obterColecao());
}
catch (APIRequestException $exception)
{
    dump($exception->toJson());
}
catch (\Exception $exception)
{
    dump($exception->getMessage());
}
?>

Documentação para os Endpoints da API

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

Recurso	Descrição
autenticacoes	Contém todos os endpoints/métodos para as autenticações
tribunais	Contém todos os endpoints/métodos para os tribunais
certificados	Contém todos os endpoints/métodos para os seus certificados
intimacoes	Contém todos os endpoints/métodos para intimações capturadas
usuarios	Contém todos os endpoints/métodos para seu usuário
notificacoes	Contém todos os endpoints/métodos para as notificações do seu usuário
webhooks	Contém todos os endpoints/métodos para os webhooks do usuário
acoes	Contém todos os endpoints/métodos para ações realizadas no `Intima.ai`
copiasProcessuais	Contém todos os endpoints/métodos para as cópias processuais
escutasProcessuais	Contém todos os endpoints/métodos para as escutas processuais
protocolosDeHabilitacao	Contém todos os endpoints/métodos para os protocolos de habilitação
informacoesProcessuais	Contém todos os endpoints/métodos para as informações processuais
andamentosProcessuais	Contém todos os endpoints/métodos para os andamentos processuais
protocolosProcessuais	Contém todos os endpoints/métodos para os protocolos
consultasProcessuais	Contém todos os endpoints/métodos para consultas processuais e pré-análises
creditos	Contém todos os endpoints/métodos para os recurso de créditos no INTIMA.AI

Documentação para Autenticação

API Token

Tipo: API Key
Parametro da API: api_token
Localização: URL query string

brainydigital / intima.ai-sdk-php

Maintainers

Details