Antes de avançar
Autenticação na API
Todas as requisições http feitas aos servidores da Oystr devem conter, no header da requisição, o parâmetro X-Oystr-Auth, com o seu token de autenticação.
Todas as requisições para nossa API demandam o uso do header X-Oystr-Auth, ele é obrigatório. Caso o token não seja informado no header da requisição ou caso o token seja inválido, o retorno do servidor, nas demais requisições, será HTTP/1.1 403 Forbidden, indicando a ausência de permissões para efetuar a requisição.
O método /ping é utilizado apenas para realização de autenticação na API. Para saber como obter a o seu token, acesse o link abaixo e siga as instruções ali definidas.
Como obter a chave de API
Antes de mais nada, a primeira coisa que você precisa fazer é obter a sua chave de API (API Key). Sem ela, você não conseguirá se autenticar na API e, consequentemente, não conseguirá consumir seus métodos.
Abaixo, segue um passo a passo de como obter a sua chave de API:
- Acesse o Console/Painel da Oystr (https://console4.oystr.com.br);
Sua chave será criada e exibida no console. Para consumir a API, basta copiar a chave criada e passar no HEADER, conforme indicado no método de Autenticação na API.
Conceitos
Todos os robôs da Oystr tem um nome e versão. Os robôs da Oystr trabalham e operam em execuções. Uma execução contém itens que fazem parte de uma fila. Cada item da fila é consumida por uma execução de robô. As execuções podem ter vários robôs trabalhando ao mesmo tempo. Após a execução é possível você ter acesso aos dados de relatório e saída do robô.
De maneira geral, para se criar uma execução e rodar um robô, temos que realizar as seguintes tarefas na ordem descrita:
| Ordem | Tipo | Descrição |
|---|---|---|
| 0.1 | Opcional | Validar as credenciais que serão utilizadas pelos robôs para acessar um sistema (tribunal, gestão jurídico, etc) |
| 0.2 | Opcional | Executar uma proto fila para obter itens |
| 1 | Obrigatório | Criar uma fila de itens |
| 2 | Obrigatório | Anexar arquivos a fila de itens (apenas para os robôs que fazem upload de arquivos) |
| 3 | Obrigatório | Iniciar a execução |
| 4 | Obrigatório | Consultar o status da execução |
| 5 | Obrigatório | Consultar o informações da execução |
| 6 | Obrigatório | Validar as respostas/dados/journal da execução |
| 7 | Obrigatório | Obter o relatório/resultado da execução |