kattatzu / Sbif by kattatzu

Consulta de indicadores al API de la SBIF (Chile)
960
8
3
Package Data
Maintainer Username: kattatzu
Maintainer Contact: kattatzu@gmail.com (Jose Eduardo Rios)
Package Create Date: 2017-07-14
Package Last Update: 2024-04-08
Home Page: https://kattatzu.github.io/sbif
Language: PHP
License: MIT
Last Refreshed: 2024-04-24 03:04:04
Package Statistics
Total Downloads: 960
Monthly Downloads: 3
Daily Downloads: 0
Total Stars: 8
Total Watchers: 3
Total Forks: 8
Total Open Issues: 0

SBIF API

Libreria que permite consultar el valor de indicadores al API de la superintendencia de bancos e instituciones financieras (SBIF) de Chile. Pueden acceder a los siguientes indicadores:

  • Dólar
  • Euro
  • UF
  • UTM
  • IPC

Además se puede acceder a información de bancos de Chile.

Obtener API key

Para usar el API de la SBIF debes obtener tu APIKEY en la siguiente página: http://api.sbif.cl/api/contactanos.jsp

Instalación

Para instalar la librería ejecuta el siguiente comando en la consola:

composer require kattatzu/sbif

Instalación y Uso en Laravel

Uso de forma Standalone

Si tu sistema no trabaja con Laravel puedes usarlo de forma directa:

use Kattatzu/Sbif/Sbif;

$sbif = new Sbif('SBIF API KEY');
// o
$sbif = new Sbif;
$sbif->apiKey('SBIF API KEY');

echo $sbif->getDollar('2017-04-30');
//664.0

Indicadores disponibles

$date = Carbon::today();

$sbif->getDollar($date);
$sbif->getEuro($date);
$sbif->getUTM($date);
$sbif->getUF($date);
$sbif->getIPC($date);
// NOTA: El IPC solo tiene valor hasta el mes anterior

// Si no envias una fecha se toma la fecha actual
$sbif->getDollar();

También puedes consultar de forma dinámica

$sbif->getIndicator(Sbif::IND_EURO, $date);

Constantes disponibles

Sbif::IND_UF
Sbif::IND_UTM
Sbif::IND_DOLLAR
Sbif::IND_EURO
Sbif::IND_IPC

Puedes acceder al resto de los datos que disponibiliza la SBIF (http://api.sbif.cl/que-es-api.html) enviando directamente el endpoint que corresponda:

var_dump($sbif->get("/resultados/2009/12/instituciones"));

object(stdClass){
    "DescripcionesCodigosDeInstituciones": [
        "0" => {
            "CodigoInstitucion": "001",
            "NombreInstitucion": "BANCO DE CHILE"
        },
        "1" => {
            "CodigoInstitucion": "014",
            "NombreInstitucion": "SCOTIABANK CHILE"
        },
        ...
    ]
}

Información de Bancos

Puedes consultar la información que disponibiliza la SBIF sobre los bancos de Chile.

$info = $sbif->getInstitutionData('001');
echo $info->name;
// BANCO DE CHILE

Puedes obtener la información como un array:

$info = $sbif->getInstitutionData('001')->toArray();
var_dump($info);
[
  "code" => "001",
  "name" => "BANCO DE CHILE",
  "swift_code" => "BCHI CL RM",
  "rut" => "97.004.000-5",
  "address" => "AHUMADA 251",
  "phone" => "(56-2) 653 11 11",
  "website" => "www.bancochile.cl",
  "public_contact" => "Pamela Valdivia",
  "public_address" => "Huérfanos 980, 8º Piso, Santiago",
  "public_phone" => "(56-2) 653 06 73",
  "branches" => 403,
  "employees" => 11426,
  "publication_date" => "2017-05-01",
  "cashiers" => 1412
]

Para obtener el listado de códigos puedes usar la clase Institution:

use Kattatzu\Sbif\Institution;

var_dump((new Institution)->getInstitutions());
[
  "001" => "Banco de Chile",
  "009" => "Banco Internacional",
  "014" => "Scotiabank Chile",
  "016" => "Banco de Credito E Inversiones",
  "028" => "Banco Bice",
  "031" => "HSBC Bank (chile)",
  "037" => "Banco Santander-chile",
  "039" => "Itaú Corpbanca",
  "049" => "Banco Security",
  "051" => "Banco Falabella",
  "053" => "Banco Ripley",
  "054" => "Rabobank Chile",
  "055" => "Banco Consorcio",
  "056" => "Banco Penta",
  "504" => "Banco BBVA",
  "059" => "Banco BTG Pactual Chile",
  "012" => "Banco del Estado de Chile",
  "017" => "Banco Do Brasil S.A.",
  "041" => "JP Morgan Chase Bank, N. A.",
  "043" => "Banco de la Nacion Argentina",
  "045" => "The Bank of Tokyo-mitsubishi UFJ",
  "060" => "China Construction Bank"
]

Instalación y Uso en Laravel

Después de hacer la instalación con Composer debes registrar el ServiceProvider y el alias en tu archivo config/app.php:

'providers' => [
    ...
    Kattatzu\Sbif\Providers\SbifServiceProvider::class,
],
'aliases' => [
    ...
    'Sbif' => Kattatzu\Sbif\Facades\SbifFacade::class,
]

Publica el archivo de configuración ejecutando en Artisan:

php artisan vendor:publish --provider="Kattatzu\Sbif\Providers\SbifServiceProvider"

Ya puedes ingresar tu API Key en el archivo de configuración config/sbif.php o en en archivo .env con la key SBIF_API_KEY.

SBIF_API_KEY=xxxxxxxxxxxxxxxxxxxx

Facades

Ya puedes usar el Facade para acceder de forma rápida a las funciones:

Sbif::getDollar();
Sbif::getUTM('2017-06-30');
Sbif::getUF(Carbon::today());

Helpers

También puedes utilizar los helpers:

sbif_dollar();
sbif_euro('2017-06-30');
sbif_utm(Carbon::yesterday());
sbif_uf(Carbon::now()->subMonth(1));
sbif_ipc();
sbif_institution('001')->name;
sbif_institutions();

No dudes en enviarme tus feedbacks o pull-request para mejorar esta librería.

Licencia

MIT License

Copyright (c) 2017 José Eduardo Ríos

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.