35 lines
947 B
Markdown
35 lines
947 B
Markdown
# ETA API
|
|
|
|
ETA Viaporte API
|
|
|
|
# Dependencies
|
|
|
|
- NodeJS v18
|
|
- Docker
|
|
|
|
# Endpoints
|
|
|
|
All endpoints that return a list of elements is paginable with the following queries:
|
|
- `elements`: Number of elements for each page.
|
|
- `page`: Page number (from 0 to n)
|
|
|
|
Example:
|
|
- `/endpoint?elements=50&page=2` : Get page 2 with 50 elements per page.
|
|
- `/endpoint?page=2` : Get page 2 with default (10) elements per page.
|
|
- `/endpoint?elements=50` : Get page 0 with 50 elements.
|
|
|
|
## Public endpoints
|
|
|
|
Read registered resources:
|
|
|
|
- `/cities`: List registered cities.
|
|
- `/countries`: List registered countries.
|
|
- `/product-categories`: List registered product-categories.
|
|
- `/states`: List registered states.
|
|
|
|
All these endpoints support the following parameters:
|
|
|
|
- `/` : List registered resources with pagination.
|
|
- `/:id` : Read specific resource identified by Id.
|
|
- `/find?regex=xxx` : List resources that matches with regex (support pagination).
|