API Sucursales


Contenidos

Objetivo

Disponer a nuestros clientes un medio seguro donde consultar las sucursales de CorreosChile.

Importante:
Cada cliente poseerá una credencial de acceso para la integración.
Puede consultar en Control de Acceso para mas información.


Formato Request
Se enviará un mensaje con la siguiente estructura:
Nota: Las sucursales volverán ordenadas por nombre.

Adicionalmente pueden consultarse específicamente las sucursales por comuna de la siguiente forma:
Nota: En caso de que el identificador de la comuna no sea válido el sistema devuelve un error.

Formato Response
Respuesta Satisfactoria

Dentro del body se enviará un objeto JSON con los campos listados a continuación.

Nombre Tipo de dato Descripción
IATA texto Identificador único de la sucursal.
Nombre texto Nombre de la sucursal.
Tipo texto Indica si se trata de una Sucursal o Agencia.
Idcomuna texto Identificador de la comuna.
Comuna texto Nombre de la comuna.
Region texto Nombre de la región.
Direccion texto Dirección de la sucursal.
Direccion_Numero texto Número de calle de la sucursal.
Observacion texto Observaciones relativas a la sucursal.
LunesViernesAM texto Horario para días ente lunes y viernes por la mañana.
LunesViernesPM texto Horario para días ente lunes y viernes por la tarde.
Sabado texto Horario para días Sábados.
DomingoFestivo texto Horario para días Domingo y Festivos.
OtroHorario texto Información adicional respecto a los horarios.
Activo texto Indica sí la sucursal o agencia se encuentra abierta o cerrada.
Latitud texto Latitud donde se encuentra la sucursal.
Longitud texto Longitud donde se encuentra la sucursal.
CodPostal texto Código postal de la sucursal
Telefono texto Teléfono de la sucursal


Status Codes
Status Descripción Acción
200 Cuando la solicitud fue procesada satisfactoriamente. Arreglo con las sucursales.
400 Cualquier error del lado del cliente. Cualquier falla en el payload, como un header o body erroneo.
500 Cualquier error del lado del servidor. Cualquier falla operativa interna, como no poder conectar con la base de datos.

Ejemplos
Request
Response

Ok (200)



Error (400)



Error (500)



Códigos de ejemplo
//Si desea utilizar usuario y contraseña
var usuario = "[USUARIO]";
var password = "[CONTRASEÑA]";
var authorization = "basic " + Buffer.from(usuario + ":" + password).toString('base64');

//Si desea utilizar el token de acceso
var authorization = "token [TOKEN DE ACCESO]";

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://cert-apib2bv2.correos.cl:8000/sucursales',
  'headers': {
    'Authorization': authorization
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

var client = new RestClient("https://cert-apib2bv2.correos.cl:8000/sucursales") {
    client.Timeout = -1
}
var request = new RestRequest(Method.GET);

//Si desea utilizar usuario y contraseña
var usr = "[USUARIO]";
var pwd = "[CONTRASEÑA]";
var authorization = Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes(usr + ":" + pwd));
request.AddHeader("Authorization", "basic " + authorization);

//Si desea utilizar el token de acceso
var token = "[TOKEN DE ACCESO]"

request.AddHeader("Authorization", authorization);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
//import okhttp3.Credentials;
//import okhttp3.OkHttpClient;

//Si desea utilizar usuario y contraseña
String usuario = "[USUARIO]";
String contrasena = "[CONTRASEÑA]";
String authorization = "basic " + Credentials.basic(usuario, contrasena);

//Si desea utilizar token de acceso
String authorization = "token [TOKEN DE ACCESO]";

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://cert-apib2bv2.correos.cl:8000/sucursales")
  .method("GET", null)
  .addHeader("Authorization", authorization)
  .build();
Response response = client.newCall(request).execute();
//Si desea utilizar usuario y contraseña
$usuario = '[USUARIO]';
$contrasena = '[CONTRASEÑA]';
$authorization = 'basic' . base64_encode($usuario . ':' . $contrasena);

//Si desea utilizar token de acceso
$token = '[TOKEN DE ACCESO]';
$authorization = 'token' . token;

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://cert-apib2bv2.correos.cl:8000/sucursales',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: ' . $authorization
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;