@aletheia-data/aletheia-sdk v0.4.2

Aletheia SDK

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:

Open Data

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

OFFICIAL:

UNOFFICIAL:

🙏🏾 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:

• Portal de API's Dominicano
• Ministerio de Administración Publica (MAP)
• Oficina Gubernamental de Tecnologías de la Información y Comunicación (OGTIC)
• Dirección General de Contrataciones Públicas (DGCP)
• Dirección General de Impuestos Internos (DGII)
• Dirección General de Ética e Integridad Gubernamental (DIGEIG)

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:

• Code of Conduct →

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