adicionados exemplos de uso da API via curl

/closes #41
turicas · Mar 28, 2020 · 7a9117a · 7a9117a
1 parent b888099
commit 7a9117a
Showing 1 changed file with 179 additions and 13 deletions.
diff --git a/api.md b/api.md
@@ -42,23 +42,13 @@ dados](https://drive.google.com/open?id=1escumcbjS8inzAKvuXOQocMcQ8ZCqbyHU5X5hFr
 
 ## Documentação da API
 
-### Boletim
-
-Colunas:
-
-- 🔍 `search` (full text search)
-- 🔍 `date` (YYY-MM-DD)
-- 🔍 `state` (2 dígitos)
-- `url`: link para o boletim
-- `notes`: observações sobre esse boletim
-
-🔍 = colunas que podem ser filtrados via query string na API e na interface.
+### Casos
 
-### Caso
+`https://brasil.io/api/dataset/covid19/dados/caso`
 
 - 🔍 `search` (full text search)
 - 🔍 `date` (YYY-MM-DD)
-- 🔍 `state` (2 dígitos)
+- 🔍 `state` (sigla da UF, ex : SP)
 - 🔍 `city` (pode estar em branco quando o registro é referente ao estado, pode ser preenchido com `Importados` também)
 - 🔍 `place_type` (`city` ou `state`)
 - 🔍 `is_last` (`True` ou `False`, diz se esse registro é o mais atual para esse município/estado)
@@ -71,6 +61,182 @@ Colunas:
 
 🔍 = colunas que podem ser filtrados via query string na API e na interface.
 
+#### Exemplos
+
+Recuperando todos os casos :
+
+```shell
+curl -X GET https://brasil.io/api/dataset/covid19/caso/data
+{
+  "count": 2023,
+  "next": "https://brasil.io/api/dataset/covid19/caso/data?page=2",
+  "previous": null,
+  "results": [
+    {
+      "city": "Rio Branco",
+      "city_ibge_code": "1200401",
+      "confirmed": 25,
+      "confirmed_per_100k_inhabitants": 6.1377,
+      "date": "2020-03-27",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 407319,
+      "is_last": true,
+      "place_type": "city",
+      "state": "AC"
+    },
+    {
+      "city": null,
+      "city_ibge_code": "12",
+      "confirmed": 25,
+      "confirmed_per_100k_inhabitants": 2.83468,
+      "date": "2020-03-27",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 881935,
+      "is_last": true,
+      "place_type": "state",
+      "state": "AC"
+    },
+...
+```
+
+Recuperando os dados mais atualizados de Alagoas :
+
+```shell
+curl -X GET https://brasil.io/api/dataset/covid19/caso/data?is_last=true&state=AL
+{
+  "count": 3,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "city": "Maceió",
+      "city_ibge_code": "2704302",
+      "confirmed": 10,
+      "confirmed_per_100k_inhabitants": 0.9814,
+      "date": "2020-03-26",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 1018948,
+      "is_last": true,
+      "place_type": "city",
+      "state": "AL"
+    },
+    {
+      "city": "Porto Real do Colégio",
+      "city_ibge_code": "2707503",
+      "confirmed": 1,
+      "confirmed_per_100k_inhabitants": 4.98355,
+      "date": "2020-03-26",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 20066,
+      "is_last": true,
+      "place_type": "city",
+      "state": "AL"
+    },
+    {
+      "city": null,
+      "city_ibge_code": "27",
+      "confirmed": 11,
+      "confirmed_per_100k_inhabitants": 0.3296,
+      "date": "2020-03-26",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 3337357,
+      "is_last": true,
+      "place_type": "state",
+      "state": "AL"
+    }
+  ]
+}
+```
+
+Recuperando apenas os dados acumulados mais recentes dos Estados :
+
+```shell
+curl -X GET https://brasil.io/api/dataset/covid19/caso/data?is_last=True&place_type=state
+{
+  "count": 27,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "city": null,
+      "city_ibge_code": "12",
+      "confirmed": 25,
+      "confirmed_per_100k_inhabitants": 2.83468,
+      "date": "2020-03-27",
+      "death_rate": null,
+      "deaths": 0,
+      "estimated_population_2019": 881935,
+      "is_last": true,
+      "place_type": "state",
+      "state": "AC"
+    },
+    {
+      "city": null,
+      "city_ibge_code": "13",
+      "confirmed": 81,
+      "confirmed_per_100k_inhabitants": 1.95435,
+      "date": "2020-03-27",
+      "death_rate": 0.0123,
+      "deaths": 1,
+      "estimated_population_2019": 4144597,
+      "is_last": true,
+      "place_type": "state",
+      "state": "AM"
+    },
+...
+```
+
+### Boletim
+
+`https://brasil.io/api/dataset/covid19/boletim/data`
+
+Colunas:
+
+- 🔍 `search` (full text search)
+- 🔍 `date` (YYY-MM-DD)
+- 🔍 `state` (sigla da UF, ex.: SP)
+- `url`: link para o boletim
+- `notes`: observações sobre esse boletim
+
+🔍 = colunas que podem ser filtrados via query string na API e na interface.
+
+#### Exemplos
+
+Recuperando todos os boletins do estado de São Paulo :
+
+```shell
+curl -X GET https://brasil.io/api/dataset/covid19/boletim/data?state=sp
+{
+  "count": 28,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "date": "2020-03-26",
+      "notes": null,
+      "state": "SP",
+      "url": "http://www.saude.sp.gov.br/resources/cve-centro-de-vigilancia-epidemiologica/areas-de-vigilancia/doencas-de-transmissao-respiratoria/coronavirus/coronavirus2603_31situacao_epidemiologica.pdf"
+    },
+    {
+      "date": "2020-03-25",
+      "notes": "e-mail recebido pelo Turicas",
+      "state": "SP",
+      "url": "http://www.saude.sp.gov.br/resources/cve-centro-de-vigilancia-epidemiologica/areas-de-vigilancia/doencas-de-transmissao-respiratoria/coronavirus/coronavirus2503_30situacao_epidemiologica.pdf"
+    },
+    {
+      "date": "2020-03-24",
+      "notes": null,
+      "state": "SP",
+      "url": "http://www.portaldenoticias.saude.sp.gov.br/sp-registra-40-obitos-relacionados-a-covid-19/"
+    },
+...
+```
+
 ### Dicas de uso
 
 - [Preencha o formulário de filtros na página do