Previdência - Cliente - Certificado (Experimental (v2))

Histórico de modificações da API

Certificado - Detalhes

Obter detalhe do Certificado

Experimente

Solicitar URL

Parâmetros de solicitação

string

Identificação do Cliente - CPF

string

Identificação do Certificado

Cabeçalhos de solicitação

string

Código da Empresa

string
A chave de API atribuída a um indivíduo para acessar a API. Você pode encontrar a chave de API em sua conta.

Corpo da solicitação

Resposta 200

OK

{
  "statusCertificado": "ATIVO",
  "dataCancelamento": null,
  "regimeTributacao": "REGRESSIVO",
  "nomeParticipante": "JOSE DA SILVA",
  "cpf": "00523811781",
  "numeroProposta": "003000326864",
  "tipoCertificado": "PARTICIPANTE",
  "dataImplantacao": "2015-11-06T00:00:00",
  "dataInicio": "2015-12-09T00:00:00",
  "dataFimDiferimento": null,
  "dataAdmissao": "2001-01-15T00:00:00",
  "tabuaAtuarial": " ",
  "fatorAtualDeRenda": "0,00613300",
  "statusFaturamento": "ATIVO",
  "garantiaRenda": "Renda Mensal Vitalícia",
  "tipoRenda": null,
  "numeroPlanoSUSEP": "000001.000001/2018-11",
  "nomePlano": "VGBL ICATU PRIVILEGE RENDA FIXA - AVERBADO",
  "dataProximoReajusteContribuicao": "2016-12-09T00:00:00",
  "valorPatrimonio": 0,
  "logradouro": "PRACA 22 ABRIL N.º 36",
  "bairro": "PIRATININGA",
  "cidade": "NITEROI",
  "uf": "RJ",
  "cep": null,
  "pais": "Brasil",
  "telefone": "38243900",
  "numeroContrato": "000090092820",
  "email": "grupohomologacaopgbl@icatuseguros.com.br",
  "cnpj": "",
  "salario": 10,
  "matriculaFuncionario": "",
  "tipoContasCertificado": null
}
{
  "type": "object",
  "properties": {
    "statusCertificado": {
      "type": "string"
    },
    "dataCancelamento": {
      "format": "date-time",
      "type": "string"
    },
    "regimeTributacao": {
      "type": "string"
    },
    "nomeParticipante": {
      "type": "string"
    },
    "CPF": {
      "type": "string"
    },
    "numeroProposta": {
      "type": "string"
    },
    "tipoCertificado": {
      "type": "string"
    },
    "dataImplantacao": {
      "format": "date-time",
      "type": "string"
    },
    "dataInicio": {
      "format": "date-time",
      "type": "string"
    },
    "dataFimDiferimento": {
      "format": "date-time",
      "type": "string"
    },
    "dataAdmissao": {
      "format": "date-time",
      "type": "string"
    },
    "tabuaAtuarial": {
      "type": "string"
    },
    "fatorAtualDeRenda": {
      "type": "string"
    },
    "statusFaturamento": {
      "type": "string"
    },
    "garantiaRenda": {
      "type": "string"
    },
    "tipoRenda": {
      "type": "string"
    },
    "numeroPlanoSUSEP": {
      "type": "string"
    },
    "nomePlano": {
      "type": "string"
    },
    "dataProximoReajusteContribuicao": {
      "format": "date-time",
      "type": "string"
    },
    "valorPatrimonio": {
      "format": "double",
      "type": "number"
    },
    "logradouro": {
      "type": "string"
    },
    "bairro": {
      "type": "string"
    },
    "cidade": {
      "type": "string"
    },
    "UF": {
      "type": "string"
    },
    "CEP": {
      "type": "string"
    },
    "pais": {
      "type": "string"
    },
    "telefone": {
      "type": "string"
    },
    "numeroContrato": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "CNPJ": {
      "type": "string"
    },
    "salario": {
      "format": "double",
      "type": "number"
    },
    "matriculaFuncionario": {
      "type": "string"
    },
    "tipoContasCertificado": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "codigoTipoConta": {
            "type": "string"
          },
          "descricaoNomeConta": {
            "type": "string"
          }
        }
      }
    }
  }
}

Resposta 401

Unauthorized

Resposta 404

Resposta 422

Unprocessable Entity

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Resposta 500

InternalServerError

{
  "status": "string",
  "mensagem": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "mensagem": {
      "type": "string"
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}"
-H "CodigoEmpresa: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
namespace CSHttpClientSample
{
    using System;
    using System.Net.Http.Headers;
    using System.Text;
    using System.Net.Http;
    using System.Web;

    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("CodigoEmpresa", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("CodigoEmpresa", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("CodigoEmpresa","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"CodigoEmpresa"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'CodigoEmpresa' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'CodigoEmpresa': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/pos-venda/v2/clientes/{idcliente}/certificados/{idcertificado}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['CodigoEmpresa'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body