npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@aletheia-data/aletheia-sdk

v0.4.2

Published

Aletheia SDK

Downloads

40

Readme

Aletheia SDK

GitHub license GitHub issues GitHub stars GitHub forks GitHub release GitHub contributors GitHub pull-requests GitHub last-commit

The Aletheia SDK is a powerful software development kit designed to streamline the integration and utilization of key services and open data provided by various Dominican Republic government and private organizations. It offers a comprehensive set of tools and libraries for developers to seamlessly interact with open data, services and the Aletheia platform's datasets, accessing valuable information for applications, analysis, and decision-making.

Installation

To install the Aletheia SDK, simply run the following command in your project's root directory:

npm install @aletheia-data/aletheia-sdk

Usage

To use the Aletheia SDK in your project, import the necessary modules and start using the provided functions and classes. Here's an example:

const AletheiaSDK = require('@aletheia-data/aletheia-sdk'); 

// (TBD) Replace 'YOUR_API_KEY' and 'YOUR_AUTH_DOMAIN' with your actual API key and authentication domain
const apiKey = 'YOUR_API_KEY';
const authDomain = 'YOUR_AUTH_DOMAIN';

// Initialize the Aletheia SDK
const aletheiaSDK = new AletheiaSDK(apiKey, authDomain);

async function getCitizenData() {
    try {
      const isValid = await aletheiaSDK.services.validateCitizenCedula('40253....');
      console.log('Citizen Cedula:', isValid);
    } catch (error) {
      console.error('Error retrieving citizen data:', error);
    }
  }

getCitizenData();

async function getOpenAPIMap() {
    // Example: Retrieve data from the MAP
    try {
      const mapData = await aletheia.opendata.gob('map').datosAbiertos('servicios_publicos', 'json');
      console.log('Map Data:', mapData);
    } catch (error) {
      console.error('Error retrieving map data:', error);
    }
  }

getOpenAPIMap();

Services

The Aletheia SDK provides services from the following providers:

| Name | API URL | API Specs | Status | Authentication | Provider | | -------------------------------------- | ------------------------------------------ | --------------------------------------------| ------------ | ---------------------- | ------------------ | | Validación Cedula | https://api.digital.gob.do/ | API Specs | up-to-date | No | Portal de API's Dominicano | | Fuel Prices | https://api.digital.gob.do/ | API Specs | up-to-date | No | Portal de API's Dominicano | | Territory Data | https://api.digital.gob.do/ | API Specs | up-to-date | No | Portal de API's Dominicano |

Open Data

The Aletheia SDK provides open data from the following API endpoints:

OFFICIAL:

| Name | API URL | API Specs | Status | Authentication | | -------------------------------------- | ------------------------------------------ | --------------------------------------------| ------------ | ---------------------- | | Aletheia Data | https://aletheiadata.org/ | API Specs | up-to-date | No | | Ministerio de Administración Publica (MAP) | https://map.gob.do/api/ | API Specs | up-to-date | Yes/No | | Dirección General de Contrataciones Públicas (DGCP) | https://api.dgcp.gob.do/ | API Specs | up-to-date | Yes/No | | Dirección General de Impuestos Internos (DGII) | https://dgii.gov.do//wsMovilDGII/WSMovilDGII.asmx?WSDL | Not Available | up-to-date | Yes/No | | Datos Abiertos (Datos.gob.do) | https://datos.gob.do/ | Not Available | up-to-date | No | | Ministerio de Trabajo de la República Dominicana (MIT) | https://webapi.mt.gob.do/ | API Specs | up-to-date | Yes/No | | Portal de API's Dominicano | https://developer.digital.gob.do/server/portal/environments/DEFAULT | Not Available | up-to-date | No | | Ministerio de Medio Ambiente y Recursos Naturales | https://apisolicitudambiental.ambiente.gob.do/swagger/index.html | API Specs | up-to-date | Yes/No |

UNOFFICIAL:

| Name | API URL | API Specs | Status | Authentication | | -------------------------------------- | ------------------------------------------ | --------------------------------------------| ------------ | ---------------------- | | API Bancos republica dominicana | https://github.com/Erinxon/api-bancos-republica-dominicana | API Specs | up-to-date | No |

🙏🏾 Special Thanks

We extend our sincere gratitude to all Dominican governments and private organizations that contribute to the public good by publishing their APIs and open data. Their commitment to transparency and accessibility empowers developers and enhances the capabilities of our development community.

A big thank you to:

Your dedication to open data and public service is invaluable and greatly appreciated.

💖 Contributing

We welcome contributions in form of bug reports, feature requests, code changes, or documentation improvements.

Please make sure to follow our guidelines:

For important changes please create first an (issue)[https://github.com/Aletheia-Data/aletheia-sdk/issues/new] to discuss what you would like to change.

Plase make sure that for each PR the necessary test are done.

License

MIT License

Copyright (c) 2023 Aletheia Data

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.

MIT