Home

Welcome to the api-el-salvador wiki! 🎍

This is the format wiki which contains information about the structure of endpoint in API. This is a very simple API but it contains many services like image scraper by official Google's and Microsoft's API and an own zip-codes scraper for municipalities.

To begin, go to /docs to see all endpoints availables and its slight documentation.

Database

The engine used is PostgreSQL. It has three entities and the SQL script can be found in repo mentioned at below of README.md. The physical diagram follows this structure:

erDiagram

    zonesv ||--o{ depsv : contains
    zonesv {
        serial id
        varchar zonename
    }
    depsv ||--|{ munsv : contains
    depsv {
        serial id
        int zonesv_id
        varchar depname
        varchar isocode
    }
    munsv {
        serial id
        int depsv_id
        varchar munname
    }

Loading

Scrapers

The most important packages used for this purpose are four. They will have its own page to explain deeply how they work. There are image-bing-urls, Google-Image-API, Bing-Search-Web and an own package souvenir-sv.