WEB SERVICE

Consulta e Consumo da API


Catálogo de Espécies
GET
https://siati.angra.rj.gov.br/api/secretaria_pesca_get_especies
Esta URL devolve um Object JSON com todas as espécies de peixes catalogadas pela Secretaria da Pesca.
https://siati.angra.rj.gov.br/api/secretaria_pesca_get_especies/search/{nome da espécie}
Esta URL devolve um Object JSON com uma espécies de peixes específica catalogadas pela Secretaria da Pesca.
Basta fornecer o nome ou parte do nome de uma espécie em {nome da espécie} no final da URL.
Parâmetros
Nome Descrição
id Identificador único da espécie.
created Data que o registro da espécie foi criado.
updated Data que o registro da espécie foi atualizado.
name Nome da espécie.
status Indica se a espécie está ativa ou não.
Resposta
Status: 200 - Object JSON
[
 {
  "id":24,
  "created":"2022-11-07 09:14:12",
  "updated":"2022-11-07 09:14:12",
  "name":"Bonito Cachorro",
  "status":1
 }
]


Catálogo de Portos
GET
https://siati.angra.rj.gov.br/api/secretaria_pesca_get_portos
Esta URL devolve um Object JSON com todos os portos catalogados pela Secretaria da Pesca.
https://siati.angra.rj.gov.br/api/secretaria_pesca_get_portos/search/{nome do porto}
Esta URL devolve um Object JSON com um porto específico catalogados pela Secretaria da Pesca.
Basta fornecer o nome ou parte do nome de um porto em {nome do porto} no final da URL.
Parâmetros
Nome Descrição
id Identificador único do porto.
created Data que o registro do porto foi criado.
updated Data que o registro do porto foi atualizado.
port_type Tipo do porto.
name Nome do porto.
uf Unidade federativa que pertence o porto.
port_authority Autoridade portuária.
delegation Delegação.
status Indica se O PORTO está ativo ou não.
Resposta
Status: 200 - Object JSON
[
 {
  "id":19,
  "created":"2022-11-11 11:47:00",
  "updated":"2022-11-11 11:47:00",
  "port_type":"Portos P\u00fablicos",
  "name":"Porto de SANTOS",
  "uf":"SP",
  "port_authority":"SPA",
  "delegation":"",
  "status":1
 }
]


Busca CEP
GET
https://siati.angra.rj.gov.br/api/cep/{informe o CEP}
Esta URL devolve um Object JSON com o endereço e outras especificações inerentes ao CEP informado.
Basta fornecer o cep desejado no formato 99999-999 com ou sem ífem em {informe o CEP} no final da URL.
Parâmetros
Nome Descrição
cep CEP que foi pesquisado.
logradouro Logradouro.
complemento Informações complementares.
bairro Bairro.
localidade Localidade.
ibge Registro do cep junto ao IBGE.
gia Indica a origem do ICMS.
ddd DDD da localidade do CEP.
siafi Número do registro do município.
Resposta
Status: 200 - Object JSON
[
 {
  "cep":"72450-050",
  "logradouro":"Quadra 5",
  "complemento":"",
  "bairro":"Setor Leste (Gama)",
  "localidade":"Bras\u00edlia",
  "uf":"DF",
  "ibge":"5300108",
  "gia":"",
  "ddd":"61",
  "siafi":"9701"
 }
]


Adicionando um Voucher
POST
URL: https://siati.angra.rj.gov.br/api/voucher_add/

PARÂMETROS PARA A REQUISIÇÃO:
{email_da_conta}
{public_key}
{private_key}
{taxa_unitario}
{taxa_qntdd}
{taxa_total}
{passeio_dt}
{nome_razao_social}
{cpf_cnpj}
{insc_municipal}
{nome_embarcacao}
{tie_embarcacao}
{name}
{email}
{phone}
Esta URL devolve um Object JSON com o código para consultar o STATUS da solicitação.
Basta fornecer o E-mail, a sua Chave Pública e a sua Chave Privada.
Por questões de segurança a sua Chave Pública e a sua Chave Privada são fornecidos apenas pela SUTIN, entre em contato com o Administrador do sistema para saber como se cadastrar.
Parâmetros
Nome Tipo Descrição
taxa_unitario Float Valor unitário da taxa.
taxa_qntdd Integer Número total de taxas para a solicitação.
taxa_total Float Resultado da multiplicação da taxa unitária e o números total de taxas.
passeio_dt Date Data do passeio.
nome_razao_social String Nome da empresa.
cpf_cnpj String CNPJ da empresa.
insc_municipal String Número da Inscrição Estadual.
nome_embarcacao String Nome da embarcação.
tie_embarcacao String Registro TIE da embarcação.
name String Nome do responsável pela solicitação.
email String E-mail do responsável pela solicitação.
phone String Telefone de contato do responsável pela solicitação.
Requisição
Com javascript use Javascript para acessar seu Endpoint.
 $("form").on("submit", function (event) {

  event.preventDefault();
  var data = $(this).serialize();

  $.ajax({
   method: "POST",
   url: "http://.com.br/seu_projeto/endpoint.php",
   dataType: 'json',
   data: data
  }).fail(function (result) {

   console.log("formGenerateKeys: Não foi possível realizar a requisição!");
   console.log(result);
   return false;

  }).done(function (result) {

   console.log(result);
   return false;

  });
  return false;
 });
Endpoint
Crie um arquivo no lado do servidor para proteger a sua {private_key}
<?php  if ($_POST) {

  $_POST["private_key"] = "5CW1-JX7L-VEW4-L3KZ-7LZ5-140T-ULO4-H";
  $url = $_POST["url"];
  unset($_POST["url"]);
  $curl = curl_init();

  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($_POST));
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);

  $result = curl_exec($curl);
  curl_close($curl);

  header('Content-Type: application/json');
  echo $result;
 }
?>
Resposta
Status: 200 - Object JSON
[
 {
  "id":15,
  "dev_id":2,
  "created":"2022-12-27 09:26:30",
  "updated":"2022-12-27 09:26:30",
  "cod":"EXHKT",
  "taxa_unitario":3.15,
  "taxa_qntdd":23,
  "taxa_total":72.45,
  "nome_razao_social":"Ferraz Turismo",
  "cpf_cnpj":"50.079.196\/0001-20",
  "name":"Elias Silva",
  "email":"elias@silva.com",
  "phone":"(48)99321-5681",
  "nome_embarcacao":"Love Boat",
  "tie_embarcacao":"0001-20",
  "passeio_dt":"2022-12-31",
  "insc_municipal":"50.079.196",
  "status":"Aguardando envio do comprovante de pagamento"
 }
]


Gerando Dynamic Key
POST
URL: https://siati.angra.rj.gov.br/api/get_dynamic_key/

PARÂMETROS PARA A REQUISIÇÃO:
{email_da_conta}
{public_key}
{private_key}
Esta URL devolve um Object JSON com o chave {dynamic_key}.
Algumas solicitações para utilizar os nossos serviços somente poderão ser realizadas com esta chave.
Parâmetros
Nome Tipo Descrição
dynamic_key Char Exatamente 36 caracteres
Requisição
Com javascript use Javascript para acessar seu Endpoint.
 $("form").on("submit", function (event) {

  event.preventDefault();
  var data = $(this).serialize();

  $.ajax({
   method: "POST",
   url: "http://localhost/seu_projeto/endpoint.php",
   dataType: 'json',
   data: data
  }).fail(function (result) {

   console.log("formGenerateKeys: Não foi possível realizar a requisição!");
   console.log(result);
   return false;

  }).done(function (result) {

   console.log(result);
   return false;

  });
  return false;
 });
Endpoint
Crie um arquivo no lado do servidor para proteger a sua {private_key}
<?php  if ($_POST) {

  $_POST["private_key"] = "5CW1-JX7L-VEW4-L3KZ-7LZ5-140T-ULO4-H";
  $url = $_POST["url"];
  unset($_POST["url"]);
  $curl = curl_init();

  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($_POST));
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);

  $result = curl_exec($curl);
  curl_close($curl);

  header('Content-Type: application/json');
  echo $result;
 }
?>
Resposta
Status: 200 - Object JSON
[
 {
  "dynamic_key":XZ44-SDP8-P3B4-BGJL-3BR4-EBZD-Z6IZ-C,
 }
]


Vouchers Upload
POST GET FILES
URL: https://siati.angra.rj.gov.br/api/voucher_send_receipt/{Código do Vouchers}

PARÂMETROS PARA A REQUISIÇÃO:
{email_da_conta}
{public_key}
{dynamic_key}
{comprovante}
Esta URL devolve um Object JSON com o código para consultar o STATUS da solicitação.
Basta fornecer o E-mail, a sua Chave Pública e a sua Chave Privada.
Por questões de segurança a sua Chave Pública e a sua Chave Privada são fornecidos apenas pela SUTIN, entre em contato com o Administrador do sistema para saber como se cadastrar.
Parâmetros
Nome Tipo Descrição
email_da_conta String Solicitar cadastro junto a Superintendência da Tecnologia da Informação - SUTIN.
public_key Char Chave pública para acesso a API.
dynamic_key Char Gerar Dynamic Key.
comprovante File Pode ser enviado o comprovante nos formatos image/* ou .pdf.
Requisição
Com javascript use Javascript para acessar seu Endpoint.
    data.append("dynamic_key", result.dynamic_key);

    $.ajax({
     method: "POST",
     url: $(".uploadURL").val(),
     dataType: 'json',
     enctype: 'multipart/form-data',
     data: data,
     processData: false,
     contentType: false,
     cache: false,
     timeout: 600000
    }).fail(function (result) {
     console.log("formSendUpload: Não foi possível realizar a requisição!");
     $(".wsAction").prop("disabled", false);
     console.log(result);
     return false;
    }).done(function (result) {

     $(".wsAction").prop("disabled", false);
     console.log(result);
     return false;

    });
     return false;
  });
  return false;
Resposta
Status: 200 - Object JSON
[
 {
  "success":"Comprovante enviado com sucesso!",
  "status":"Comprovante enviado! Aguardando confirmação de pagamento",
 }
]


Check Vouchers
POST GET
URL: https://siati.angra.rj.gov.br/api/voucher_send_receipt/{Código do Vouchers}

PARÂMETROS PARA A REQUISIÇÃO:
{email_da_conta}
{public_key}
{private_key}
{cod}
Esta URL devolve um Object JSON com o código para consultar o STATUS da solicitação.
Basta fornecer o E-mail, a sua Chave Pública e a sua Chave Privada.
Por questões de segurança a sua Chave Pública e a sua Chave Privada são fornecidos apenas pela SUTIN, entre em contato com o Administrador do sistema para saber como se cadastrar.
Parâmetros
Nome Tipo Descrição
email_da_conta String Solicitar cadastro junto a Superintendência da Tecnologia da Informação - SUTIN.
public_key Char Chave pública para acesso a API.
private_key Char Chave privada para acesso a API.
cod String Código do Voucher
Requisição
Com javascript use Javascript para acessar seu Endpoint.
 $(".myButton").click(function(){

   var $cod = $(".cod").val();
   var $email_da_conta = $(".email_da_conta").val();
   var $public_key = $(".public_key").val();
  $.ajax({
   method: "POST",
   url: "http://.com.br/seu_projeto/endpoint.php",
   dataType: 'json',
   data: "cod=" + $cod + "&email_da_conta=" + $email_da_conta + "&public_key=" + $public_key
  }).fail(function (result) {
  ; console.log("formGenerateKeys: Não foi possível realizar a requisição!");
   console.log(result);
   return false;
  }).done(function (result) {

   console.log(result);

   if(result.error == "Acesso Negado!"){
    $(".sttSolicitacao").html("

Código inexistente! Por favor, check e tente novamente.

");
   } else {
    $(".sttSolicitacao").html("

" + result.status + "

");
   }
   return false;
  });
  return false;
 });
Endpoint
Crie um arquivo no lado do servidor para proteger a sua {private_key}
<?php  if ($_POST) {

  $_POST["private_key"] = "5CW1-JX7L-VEW4-L3KZ-7LZ5-140T-ULO4-H";
  $cod = $_POST["cod"];
  $url = "http://siati.angra.rj.gov.br/api/check_vouchers/". $cod;

  $curl = curl_init();

  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($_POST));
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);

  $result = curl_exec($curl);
  curl_close($curl);

  header('Content-Type: application/json');
  echo $result;
 }
?>
Resposta
Status: 200 - Object JSON
[
 {
  "cod":"BQJZA"
  "comprovante":"https://siati.angra.rj.gov.br/www/acqua/assets/files/turisangra_vouchers/32/documento_308_11_novembro_2022.pdf"
  "cpf_cnpj":"50.079.196/0001-20"
  "created":"2022-12-28 09:37:50"
  "dev_id":30
  "email":"email@angra.rj.gov.br"
  "id":32
  "insc_municipal":"123568"
  "name":"Algusto Tores"
  "nome_embarcacao":"Rosa do Mar"
  "nome_razao_social":"Angra Turismo"
  "passeio_dt":"2022-12-28"
  "phone":"(11) 11111-1111"
  "status":"Comprovante enviado! Aguardando confirmação de pagamento"
  "taxa_qntdd":23
  "taxa_total":72.45
  "taxa_unitario":3.15
  "tie_embarcacao":"123568",
  "updated":"2022-12-28 09:37:50"
 }
]


Search Vouchers
POST
URL: https://siati.angra.rj.gov.br/api/vouchers_search/

PARÂMETROS PARA A REQUISIÇÃO:
{email_da_conta}
{public_key}
{private_key}
{search}
Esta URL devolve um Object JSON com 1 ou mais VOUCHERS e seus respectivos STATUS.
Basta fornecer o E-mail, a sua Chave Pública e a sua Chave Privada.
Por questões de segurança a sua Chave Pública e a sua Chave Privada são fornecidos apenas pela SUTIN, entre em contato com o Administrador do sistema para saber como se cadastrar.
Parâmetros
Nome Tipo Descrição
email_da_conta String Solicitar cadastro junto a Superintendência da Tecnologia da Informação - SUTIN.
public_key Char Chave pública para acesso a API.
private_key Char Chave privada para acesso a API.
search String Argumento, ex: email, código do voucher, nome da embarcação, cnpj, etc.
Requisição
Com javascript use Javascript para acessar seu Endpoint.
 $(".myButton").click(function(){

   var $search = $(".search").val();
   var $email_da_conta = $(".email_da_conta").val();
   var $public_key = $(".public_key").val();
  $.ajax({
   method: "POST",
   url: "https://.com.br/seu_projeto/endpoint.php",
   dataType: 'json',
   data: "search=" + $search + "&email_da_conta=" + $email_da_conta + "&public_key=" + $public_key
  }).fail(function (result) {
  ; console.log("formGenerateKeys: Não foi possível realizar a requisição!");
   console.log(result);
   return false;
  }).done(function (result) {

   console.log(result);

   if(result.error == "Acesso Negado!"){
    $(".sttSolicitacao").html("

Código inexistente! Por favor, check e tente novamente.

");
   }    return false;
  });
  return false;
 });
Endpoint
Crie um arquivo no lado do servidor para proteger a sua {private_key}
<?php  if ($_POST) {

  $_POST["private_key"] = "5CW1-JX7L-VEW4-L3KZ-7LZ5-140T-ULO4-H";
  $search = $_POST["search"];
  $url = "http://siati.angra.rj.gov.br/api/vouchers_search/";

  $curl = curl_init();

  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($_POST));
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);

  $result = curl_exec($curl);
  curl_close($curl);

  header('Content-Type: application/json');
  echo $result;
 }
?>
Resposta
Status: 200 - Object JSON
[
 {
  "cod":"BQJZA"
  "comprovante":"https://siati.angra.rj.gov.br/www/acqua/assets/files/turisangra_vouchers/32/documento_308_11_novembro_2022.pdf"
  "cpf_cnpj":"50.079.196/0001-20"
  "created":"2022-12-28 09:37:50"
  "dev_id":30
  "email":"email@angra.rj.gov.br"
  "id":32
  "insc_municipal":"123568"
  "name":"Algusto Tores"
  "nome_embarcacao":"Rosa do Mar"
  "nome_razao_social":"Angra Turismo"
  "passeio_dt":"2022-12-28"
  "phone":"(11) 11111-1111"
  "status":"Comprovante enviado! Aguardando confirmação de pagamento"
  "taxa_qntdd":23
  "taxa_total":72.45
  "taxa_unitario":3.15
  "tie_embarcacao":"123568",
  "updated":"2022-12-28 09:37:50"
 },
 {
  "cod":"BQJZA"
  "comprovante":"https://siati.angra.rj.gov.br/www/acqua/assets/files/turisangra_vouchers/32/documento_308_11_novembro_2022.pdf"
  "cpf_cnpj":"50.079.196/0001-20"
  "created":"2022-12-28 09:37:50"
  "dev_id":30
  "email":"email@angra.rj.gov.br"
  "id":32
  "insc_municipal":"123568"
  "name":"Algusto Tores"
  "nome_embarcacao":"Rosa do Mar"
  "nome_razao_social":"Angra Turismo"
  "passeio_dt":"2022-12-28"
  "phone":"(11) 11111-1111"
  "status":"Comprovante enviado! Aguardando confirmação de pagamento"
  "taxa_qntdd":23
  "taxa_total":72.45
  "taxa_unitario":3.15
  "tie_embarcacao":"123568",
  "updated":"2022-12-28 09:37:50"
 }
]