3.Vida - Parceiro - Pós-Venda (v3)

Histórico de modificações da API

API de pós-venda de produtos de vida.

Apólices

Obter a lista de apólices.

Experimente

Solicitar URL

Parâmetros de solicitação

integer

Identificador do cliente - CPF, CNPJ ou CEI

(opcional)
string

CPF ou CNPJ do corretor.

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

[
    {
      "apolice": 1234,
      "subestipulante": 111,
      "produto": "Global 111",
      "inicioVigencia": "2018-12-01",
      "proximaRenovacao": "2020-12-01",
      "premioTotal": 200000,
      "modulos": [
        {
          "numero": 10,
          "nome": "Modulo 10"
        },
        {
          "numero": 20,
          "nome": "Modulo 20"
        },
        {
          "numero": 30,
          "nome": "Modulo 30"
        }
      ],
      "statusApolice": "Ativo",
      "statusSubestipulante": "Ativo"
    },
    {
      "apolice": 1234,
      "subestipulante": 123,
      "produto": "Global 123",
      "inicioVigencia": "2018-12-01",
      "proximaRenovacao": "2020-12-01",
      "premioTotal": 200000,
      "modulos": [
        {
          "numero": 50,
          "nome": "Modulo 50"
        }
      ],
      "statusApolice": "Cancelada",
      "dataCancelamentoApolice": "2021-01-05",
      "statusSubestipulante": "Cancelada",
      "dataCancelamentoSubestipulante": "2021-01-05"
    }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "apolice",
      "subestipulante",
      "produto",
      "inicioVigencia",
      "proximaRenovacao",
      "premioTotal",
      "modulos"
    ],
    "properties": {
      "apolice": {
        "format": "int32",
        "type": "integer",
        "description": "numero da apolice no Sisvida"
      },
      "subestipulante": {
        "format": "int32",
        "type": "integer",
        "description": "numero do subestipulante"
      },
      "produto": {
        "type": "string",
        "description": "Nome completo do produto"
      },
      "inicioVigencia": {
        "format": "date",
        "type": "string",
        "description": "Data de Início de vigência do ramo principal da composição apólice"
      },
      "proximaRenovacao": {
        "format": "date",
        "type": "string",
        "description": "Data da próxima renovação da apólice"
      },
      "premioTotal": {
        "type": "number",
        "format": "double"
      },
      "modulos": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "numero": {
              "type": "integer",
              "description": "Número do módulo"
            },
            "nome": {
              "type": "string",
              "description": "Nome do módulo"
            }
          }
        },
        "description": "Lista de módulos",
        "minItems": 1
      },
      "statusApolice": {
        "type": "string",
        "description": "Situação da apólice"
      },
      "dataCancelamentoApolice": {
        "format": "date",
        "type": "string",
        "description": "Data de cancelamento da apólice"
      },
      "statusSubestipulante": {
        "type": "string",
        "description": "Situação da subestipulante da apólice"
      },
      "dataCancelamentoSubestipulante": {
        "format": "date",
        "type": "string",
        "description": "Data de cancelamento do subestipulante da apólice"
      }
    }
  }
}

Resposta 400

Requisição inválida.

{"status":"400.1 ou 400.2", "mensagem":"Requisição inválida."}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "readOnly": true
    },
    "mensagem": {
      "type": "string",
      "readOnly": true
    }
  }
}

Resposta 401

Acesso negado devido a chave de assinatura inválida. Certifique-se de fornecer uma chave válida para uma assinatura ativa!

{"status":"401.1 ou 401.2", "mensagem":"Acesso negado devido a chave de assinatura inválida. Certifique-se de fornecer uma chave válida para uma assinatura ativa!"}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "readOnly": true
    },
    "mensagem": {
      "type": "string",
      "readOnly": true
    }
  }
}

Resposta 403

Sem autorização para acessar o recurso solicitado.

{"status":"403.2", "mensagem":"Sem autorização para acessar o recurso solicitado."}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "readOnly": true
    },
    "mensagem": {
      "type": "string",
      "readOnly": true
    }
  }
}

Resposta 404

Recurso não encontrado.

{"status":"404.1 ou 404.2", "mensagem":"Recurso não encontrado."}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "readOnly": true
    },
    "mensagem": {
      "type": "string",
      "readOnly": true
    }
  }
}

Resposta 415

Media type inválido.

{"status":"415.1 ou 415.2", "mensagem":"Media type inválido."}

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

Resposta 422

Entidade não pode ser processada.

{"status":"422", "mensagem":"Mensagem de validação de negócio."}

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

Resposta 500

Erro interno do servidor.

{"status":"500.1 ou 500.2", "mensagem":"Erro interno no servidor."}

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

Resposta 503

Serviço indisponível.

{"status":"503.1 ou 503.2", "mensagem":"Serviço indisponível."}

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

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.icatuseguros.com.br/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices?idcorretor={string}"
-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["idcorretor"] = "{string}";
            var uri = "https://api.icatuseguros.com.br/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices?" + 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/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices");

            builder.setParameter("idcorretor", "{string}");

            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
            "idcorretor": "{string}",
        };
      
        $.ajax({
            url: "https://api.icatuseguros.com.br/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices?" + $.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/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"idcorretor={string}",
                      ];
    
    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/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'idcorretor' => '{string}',
);

$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
    'idcorretor': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices?%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
    'idcorretor': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.icatuseguros.com.br')
    conn.request("GET", "/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices?%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/relacionamento-parceiro/vida/pos-venda/v3/clientes/{idcliente}/apolices')

query = URI.encode_www_form({
    # Request parameters
    'idcorretor' => '{string}'
})
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