Previdência - Cliente (Experimental)

Histórico de modificações da API

Portabilidade Interna

Lista as solicitações de portabilidade utilizando, ou não, os parâmetros para filtro.

Experimente

Solicitar URL

Parâmetros de solicitação

string

Identificador do Cliente - CPF

(opcional)
string

Matrícula do participante.

(opcional)
string

Nome do participante.

(opcional)
string

Status da Portabilidade (InicioProcessamento = 0 / EmProcessamento = 1 / ProcessadoComCritica = 2 / Processado = 3 / Erro = 4 / Cancelado = 5).

(opcional)
string

Filtro de data inicial. Format - date-time (as date-time in RFC3339).

(opcional)
string

Filtro de data final. Format - date-time (as date-time in RFC3339).

(opcional)
integer

Página atual da listagem (1 = página inicial). Format - int32.

(opcional)
integer

Quantidade de itens a serem exibidos por paginação (Default: 10). Format - int32.

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

Lista de Solicitações de Portabilidade Interna

[
    {
        "dataSolicitacao": "2019-01-05T02:01:32",
        "participante": "EDYMOND YOUSSEF JOSEPH JUNIOR",
        "cpf": "371.960.002-45",
        "matricula": "00000001",
        "numeroSolicitacao": "201900000000000099"
    },
    {
        "dataSolicitacao": "2019-01-05T01:40:03",
        "participante": "EDYMOND YOUSSEF JOSEPH JUNIOR",
        "cpf": "371.960.002-45",
        "matricula": "00000001",
        "numeroSolicitacao": "201901050140032011"
    }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "numeroSolicitacao": {
        "type": "string"
      },
      "dataSolicitacao": {
        "format": "date-time",
        "type": "string"
      },
      "participante": {
        "type": "string"
      },
      "cpf": {
        "type": "string"
      },
      "matricula": {
        "type": "string"
      }
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/v1/clientes/{idcliente}/portabilidades-internas?matricula={string}&nome={string}&statusPortabilidade={string}&dataInicioSolicitacao={string}&dataFimSolicitacao={string}&pagina={integer}&tamanhoPagina={integer}"
-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}");

            // Request parameters
            queryString["matricula"] = "{string}";
            queryString["nome"] = "{string}";
            queryString["statusPortabilidade"] = "{string}";
            queryString["dataInicioSolicitacao"] = "{string}";
            queryString["dataFimSolicitacao"] = "{string}";
            queryString["pagina"] = "{integer}";
            queryString["tamanhoPagina"] = "{integer}";
            var uri = "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/v1/clientes/{idcliente}/portabilidades-internas?" + 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/v1/clientes/{idcliente}/portabilidades-internas");

            builder.setParameter("matricula", "{string}");
            builder.setParameter("nome", "{string}");
            builder.setParameter("statusPortabilidade", "{string}");
            builder.setParameter("dataInicioSolicitacao", "{string}");
            builder.setParameter("dataFimSolicitacao", "{string}");
            builder.setParameter("pagina", "{integer}");
            builder.setParameter("tamanhoPagina", "{integer}");

            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
            "matricula": "{string}",
            "nome": "{string}",
            "statusPortabilidade": "{string}",
            "dataInicioSolicitacao": "{string}",
            "dataFimSolicitacao": "{string}",
            "pagina": "{integer}",
            "tamanhoPagina": "{integer}",
        };
      
        $.ajax({
            url: "https://api.icatuseguros.com.br/experimental/relacionamento-cliente/previdencia/v1/clientes/{idcliente}/portabilidades-internas?" + $.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/v1/clientes/{idcliente}/portabilidades-internas";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"matricula={string}",
                         @"nome={string}",
                         @"statusPortabilidade={string}",
                         @"dataInicioSolicitacao={string}",
                         @"dataFimSolicitacao={string}",
                         @"pagina={integer}",
                         @"tamanhoPagina={integer}",
                      ];
    
    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/v1/clientes/{idcliente}/portabilidades-internas');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'matricula' => '{string}',
    'nome' => '{string}',
    'statusPortabilidade' => '{string}',
    'dataInicioSolicitacao' => '{string}',
    'dataFimSolicitacao' => '{string}',
    'pagina' => '{integer}',
    'tamanhoPagina' => '{integer}',
);

$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({
    # Request parameters
    'matricula': '{string}',
    'nome': '{string}',
    'statusPortabilidade': '{string}',
    'dataInicioSolicitacao': '{string}',
    'dataFimSolicitacao': '{string}',
    'pagina': '{integer}',
    'tamanhoPagina': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/v1/clientes/{idcliente}/portabilidades-internas?%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({
    # Request parameters
    'matricula': '{string}',
    'nome': '{string}',
    'statusPortabilidade': '{string}',
    'dataInicioSolicitacao': '{string}',
    'dataFimSolicitacao': '{string}',
    'pagina': '{integer}',
    'tamanhoPagina': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/experimental/relacionamento-cliente/previdencia/v1/clientes/{idcliente}/portabilidades-internas?%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/v1/clientes/{idcliente}/portabilidades-internas')

query = URI.encode_www_form({
    # Request parameters
    'matricula' => '{string}',
    'nome' => '{string}',
    'statusPortabilidade' => '{string}',
    'dataInicioSolicitacao' => '{string}',
    'dataFimSolicitacao' => '{string}',
    'pagina' => '{integer}',
    'tamanhoPagina' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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