Mudanças entre as edições de "API-PRODUTOS"

De SEADE
Ir para: navegação, pesquisa
(Criou página com '= Apresentação = A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações, que tornem possível a ...')
 
 
(14 edições intermediárias de um usuário não apresentadas)
Linha 5: Linha 5:
 
== URI ==
 
== URI ==
  
−
  http://api-bibliotecadigital.seade.gov.br/v1
+
  http://www.seade.gov.br/produtos/wp-json/wp/v2/
 +
 
 +
 
  
 
== Código HTTP de Retorno ==
 
== Código HTTP de Retorno ==
Linha 13: Linha 15:
 
* '''Erro''': 404.
 
* '''Erro''': 404.
  
−
http://www.seade.gov.br/produtos/wp-json/wp/v2/types
+
== Relação de Produtos (endpoints) ==
 +
 
 +
Apresenta a relação de endpoints associados a cada produtos disponíveis na API. Ex.: produtos SP Demográficos, Mulher & Trabalho, Mortalidade Infantil, Ensaio & Conjuntura e outros.
 +
 
 +
 
 +
'''GET'''
 +
 
 +
 
 +
* '''Path''': /types
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
 +
 
 +
 
 +
=== Retorno JSON ===
 +
...
 +
"spdemografico": {
 +
    "description": "",
 +
    "hierarchical": false,
 +
    "name": "SP Demográfico",
 +
    "slug": "spdemografico",
 +
    "_links": {
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
 +
        }
 +
      ],
 +
      "wp:items": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"
 +
        }
 +
      ],
 +
      "curies": [
 +
        {
 +
          "name": "wp",
 +
          "href": "https://api.w.org/{rel}",
 +
          "templated": true
 +
        }
 +
      ]
 +
    }
 +
  },
 +
"mulher-trabalho": {
 +
    "description": "",
 +
    "hierarchical": false,
 +
    "name": "Mulher e Trabalho",
 +
    "slug": "mulher-trabalho",
 +
    "_links": {
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
 +
        }
 +
      ],
 +
      "wp:items": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/mulher-trabalho"
 +
        }
 +
      ],
 +
      "curies": [
 +
        {
 +
          "name": "wp",
 +
          "href": "https://api.w.org/{rel}",
 +
          "templated": true
 +
        }
 +
      ]
 +
    }
 +
  },
 +
  "pop-negra": {
 +
    "description": "",
 +
    "hierarchical": false,
 +
    "name": "População Negra",
 +
    "slug": "pop-negra",
 +
    "_links": {
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
 +
        }
 +
      ],
 +
      "wp:items": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pop-negra"
 +
        }
 +
      ],
 +
      "curies": [
 +
        {
 +
          "name": "wp",
 +
          "href": "https://api.w.org/{rel}",
 +
          "templated": true
 +
        }
 +
      ]
 +
    }
 +
  },
 +
...
 +
 
 +
== Detalhamento do Produto - ítens ==
 +
 
 +
'''GET'''
 +
 
 +
 
 +
* '''Path''': /<slug do produto>
 +
 
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"
 +
 
 +
 
 +
=== Retorno JSON ===
 +
 
 +
[
 +
  {
 +
    "id": 7773,
 +
    "date": "2018-04-12T10:03:59",
 +
    "date_gmt": "2018-04-12T13:03:59",
 +
    "guid": {
 +
      "rendered": "http://www.seade.gov.br/produtos/?post_type=spdemografico&#038;p=7773"
 +
    },
 +
    "modified": "2018-04-12T10:03:59",
 +
    "modified_gmt": "2018-04-12T13:03:59",
 +
    "slug": "ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016",
 +
    "type": "spdemografico",
 +
    "link": "http://www.seade.gov.br/produtos/spdemografico/ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016/",
 +
    "title": {
 +
      "rendered": "Ano 18 &#8211; nº 02, abril de 2018 – O que muda na nupcialidade no Estado de São Paulo em 2016"
 +
    },
 +
    "content": {
 +
      "rendered": "As estatísticas do Registro Civil, produzidas pela Fundação Seade, indicam, para 2016, pequeno declínio no volume e nas taxas de casamentos legais do Estado de São Paulo, manutenção da tendência de aumento
 +
      das idades médias ao casar para ambos os sexos e redução da diferença entre estas. Com relação às uniões homoafetivas, observa-se acréscimo de 6,5% em relação a 2013, apesar da participação desse tipo de ...",
 +
      "protected": false
 +
    },
 +
    "author": 13,
 +
    "wpcf_url_boletim_spdemog": null,
 +
    "_links": {
 +
      "self": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico/7773"
 +
        }
 +
      ],
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"
 +
        }
 +
      ],
 +
      "about": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/spdemografico"
 +
        }
 +
      ],
 +
      "author": [
 +
        {
 +
          "embeddable": true,
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/13"
 +
        }
 +
      ],
 +
      "version-history": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico/7773/revisions"
 +
        }
 +
      ],
 +
      "wp:attachment": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=7773"
 +
        }
 +
      ],
 +
      "curies": [
 +
        {
 +
          "name": "wp",
 +
          "href": "https://api.w.org/{rel}",
 +
          "templated": true
 +
        }
 +
      ]
 +
    }
 +
  },
 +
  ...
 +
 
 +
 
 +
== relação de mídias associadas("wp:attachment") ao produto ==
 +
 
 +
 
 +
'''GET'''
 +
 
 +
 
 +
* '''Path''': /<url wp:attachment>
 +
 
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=7773"
 +
 
 +
 
 +
=== Retorno JSON ===
 +
 
 +
[
 +
  {
 +
    "id": 7774,
 +
    "date": "2018-04-11T18:05:01",
 +
    "date_gmt": "2018-04-11T21:05:01",
 +
    "guid": {
 +
      "rendered": "http://www.seade.gov.br/produtos/midia/2018/04/SPDemografico_Num-02_abril2018.-final.pdf"
 +
    },
 +
    "modified": "2018-04-11T18:05:01",
 +
    "modified_gmt": "2018-04-11T21:05:01",
 +
    "slug": "spdemografico_num-02_abril2018-final",
 +
    "type": "attachment",
 +
    "link": "http://www.seade.gov.br/produtos/spdemografico/ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016/spdemografico_num-02_abril2018-final/",
 +
    "title": {
 +
      "rendered": "SPDemografico_Num 02_abril2018. final"
 +
    },
 +
    "author": 13,
 +
    "comment_status": "closed",
 +
    "ping_status": "closed",
 +
    "meta": {
 +
     
 +
    },
 +
    "alt_text": "",
 +
    "caption": "",
 +
    "description": "",
 +
    "media_type": "file",
 +
    "mime_type": "application/pdf",
 +
    "media_details": {
 +
     
 +
    },
 +
    "post": 7773,
 +
    "source_url": "http://www.seade.gov.br/produtos/midia/2018/04/SPDemografico_Num-02_abril2018.-final.pdf",
 +
    "_links": {
 +
      "self": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media/7774"
 +
        }
 +
      ],
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media"
 +
        }
 +
      ],
 +
      "about": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/attachment"
 +
        }
 +
      ],
 +
      "author": [
 +
        {
 +
          "embeddable": true,
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/13"
 +
        }
 +
      ],
 +
      "replies": [
 +
        {
 +
          "embeddable": true,
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/comments?post=7774"
 +
        }
 +
      ]
 +
    }
 +
  }
 +
]
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
== Lista de páginas dos Produtos ==
 +
 
 +
'''GET'''
 +
 
 +
 
 +
* '''Path''': /pages
 +
 
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages"
 +
 
 +
 
 +
=== Retorno JSON ===
 +
[
 +
  {
 +
    "id": 6862,
 +
    "date": "2017-06-27T17:37:24",
 +
    "date_gmt": "2017-06-27T20:37:24",
 +
    "guid": {
 +
      "rendered": "http://www.seade.gov.br/produtos/?page_id=6862"
 +
    },
 +
    "modified": "2017-10-24T16:35:10",
 +
    "modified_gmt": "2017-10-24T18:35:10",
 +
    "slug": "ensaio-conjuntura",
 +
    "type": "page",
 +
    "link": "http://www.seade.gov.br/produtos/ensaio-conjuntura/",
 +
    "title": {
 +
      "rendered": "Ensaio &#038; Conjuntura"
 +
    },
 +
    "content": {
 +
      "rendered": "",
 +
      "protected": false
 +
    },
 +
    "excerpt": {
 +
      "rendered": "",
 +
      "protected": false
 +
    },
 +
    "author": 1,
 +
    "featured_media": 0,
 +
    "parent": 0,
 +
    "menu_order": 0,
 +
    "comment_status": "closed",
 +
    "ping_status": "closed",
 +
    "template": "page-ensaioeconjuntura.php",
 +
    "meta": {
 +
     
 +
    },
 +
    "_links": {
 +
      "self": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages/6862"
 +
        }
 +
      ],
 +
      "collection": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages"
 +
        }
 +
      ],
 +
      "about": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/page"
 +
        }
 +
      ],
 +
      "author": [
 +
        {
 +
          "embeddable": true,
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/1"
 +
        }
 +
      ],
 +
      "replies": [
 +
        {
 +
          "embeddable": true,
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/comments?post=6862"
 +
        }
 +
      ],
 +
      "version-history": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages/6862/revisions"
 +
        }
 +
      ],
 +
      "wp:attachment": [
 +
        {
 +
          "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=6862"
 +
        }
 +
      ],
 +
      "curies": [
 +
        {
 +
          "name": "wp",
 +
          "href": "https://api.w.org/{rel}",
 +
          "templated": true
 +
        }
 +
      ]
 +
    }
 +
  },

Edição atual tal como às 16h51min de 18 de maio de 2018

Índice

Apresentação

A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações, que tornem possível a visualização de informações dos produtos que em seu conteúdo reúnem boletins, relatórios analíticos, assim como tabelas de dados a eles associados, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizadas. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.

URI 

http://www.seade.gov.br/produtos/wp-json/wp/v2/


Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.

Relação de Produtos (endpoints)

Apresenta a relação de endpoints associados a cada produtos disponíveis na API. Ex.: produtos SP Demográficos, Mulher & Trabalho, Mortalidade Infantil, Ensaio & Conjuntura e outros.


GET


  • Path: /types

Sintaxe de chamada 

curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"


Retorno JSON 

...
"spdemografico": {
   "description": "",
   "hierarchical": false,
   "name": "SP Demográfico",
   "slug": "spdemografico",
   "_links": {
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
       }
     ],
     "wp:items": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"
       }
     ],
     "curies": [
       {
         "name": "wp",
         "href": "https://api.w.org/{rel}",
         "templated": true
       }
     ]
   }
 },
"mulher-trabalho": {
   "description": "",
   "hierarchical": false,
   "name": "Mulher e Trabalho",
   "slug": "mulher-trabalho",
   "_links": {
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
       }
     ],
     "wp:items": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/mulher-trabalho"
       }
     ],
     "curies": [
       {
         "name": "wp",
         "href": "https://api.w.org/{rel}",
         "templated": true
       }
     ]
   }
 },
 "pop-negra": {
   "description": "",
   "hierarchical": false,
   "name": "População Negra",
   "slug": "pop-negra",
   "_links": {
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types"
       }
     ],
     "wp:items": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pop-negra"
       }
     ],
     "curies": [
       {
         "name": "wp",
         "href": "https://api.w.org/{rel}",
         "templated": true
       }
     ]
   }
 },
...

Detalhamento do Produto - ítens

GET


  • Path: /<slug do produto>


Sintaxe de chamada 

curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"


Retorno JSON 

[
 {
   "id": 7773,
   "date": "2018-04-12T10:03:59",
   "date_gmt": "2018-04-12T13:03:59",
   "guid": {
     "rendered": "http://www.seade.gov.br/produtos/?post_type=spdemografico&p=7773"
   },
   "modified": "2018-04-12T10:03:59",
   "modified_gmt": "2018-04-12T13:03:59",
   "slug": "ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016",
   "type": "spdemografico",
   "link": "http://www.seade.gov.br/produtos/spdemografico/ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016/",
   "title": {
     "rendered": "Ano 18 – nº 02, abril de 2018 – O que muda na nupcialidade no Estado de São Paulo em 2016"
   },
   "content": {
     "rendered": "As estatísticas do Registro Civil, produzidas pela Fundação Seade, indicam, para 2016, pequeno declínio no volume e nas taxas de casamentos legais do Estado de São Paulo, manutenção da tendência de aumento 
      das idades médias ao casar para ambos os sexos e redução da diferença entre estas. Com relação às uniões homoafetivas, observa-se acréscimo de 6,5% em relação a 2013, apesar da participação desse tipo de ...",
     "protected": false
   },
   "author": 13,
   "wpcf_url_boletim_spdemog": null,
   "_links": {
     "self": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico/7773"
       }
     ],
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico"
       }
     ],
     "about": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/spdemografico"
       }
     ],
     "author": [
       {
         "embeddable": true,
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/13"
       }
     ],
     "version-history": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/spdemografico/7773/revisions"
       }
     ],
     "wp:attachment": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=7773"
       }
     ],
     "curies": [
       {
         "name": "wp",
         "href": "https://api.w.org/{rel}",
         "templated": true
       }
     ]
   }
 },
  ...


relação de mídias associadas("wp:attachment") ao produto

GET


  • Path: /<url wp:attachment>


Sintaxe de chamada 

curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=7773"


Retorno JSON 

[
 {
   "id": 7774,
   "date": "2018-04-11T18:05:01",
   "date_gmt": "2018-04-11T21:05:01",
   "guid": {
     "rendered": "http://www.seade.gov.br/produtos/midia/2018/04/SPDemografico_Num-02_abril2018.-final.pdf"
   },
   "modified": "2018-04-11T18:05:01",
   "modified_gmt": "2018-04-11T21:05:01",
   "slug": "spdemografico_num-02_abril2018-final",
   "type": "attachment",
   "link": "http://www.seade.gov.br/produtos/spdemografico/ano-18-no-02-abril-de-2018-o-que-muda-na-nupcialidade-no-estado-de-sao-paulo-em-2016/spdemografico_num-02_abril2018-final/",
   "title": {
     "rendered": "SPDemografico_Num 02_abril2018. final"
   },
   "author": 13,
   "comment_status": "closed",
   "ping_status": "closed",
   "meta": {
     
   },
   "alt_text": "",
   "caption": "",
   "description": "",
   "media_type": "file",
   "mime_type": "application/pdf",
   "media_details": {
     
   },
   "post": 7773,
   "source_url": "http://www.seade.gov.br/produtos/midia/2018/04/SPDemografico_Num-02_abril2018.-final.pdf",
   "_links": {
     "self": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media/7774"
       }
     ],
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media"
       }
     ],
     "about": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/attachment"
       }
     ],
     "author": [
       {
         "embeddable": true,
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/13"
       }
     ],
     "replies": [
       {
         "embeddable": true,
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/comments?post=7774"
       }
     ]
   }
 }
]




Lista de páginas dos Produtos

GET


  • Path: /pages


Sintaxe de chamada 

curl -X GET "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages"


Retorno JSON

[ 

 {
   "id": 6862,
   "date": "2017-06-27T17:37:24",
   "date_gmt": "2017-06-27T20:37:24",
   "guid": {
     "rendered": "http://www.seade.gov.br/produtos/?page_id=6862"
   },
   "modified": "2017-10-24T16:35:10",
   "modified_gmt": "2017-10-24T18:35:10",
   "slug": "ensaio-conjuntura",
   "type": "page",
   "link": "http://www.seade.gov.br/produtos/ensaio-conjuntura/",
   "title": {
     "rendered": "Ensaio & Conjuntura"
   },
   "content": {
     "rendered": "",
     "protected": false
   },
   "excerpt": {
     "rendered": "",
     "protected": false
   },
   "author": 1,
   "featured_media": 0,
   "parent": 0,
   "menu_order": 0,
   "comment_status": "closed",
   "ping_status": "closed",
   "template": "page-ensaioeconjuntura.php",
   "meta": {
     
   },
   "_links": {
     "self": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages/6862"
       }
     ],
     "collection": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages"
       }
     ],
     "about": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/types/page"
       }
     ],
     "author": [
       {
         "embeddable": true,
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/users/1"
       }
     ],
     "replies": [
       {
         "embeddable": true,
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/comments?post=6862"
       }
     ],
     "version-history": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/pages/6862/revisions"
       }
     ],
     "wp:attachment": [
       {
         "href": "http://www.seade.gov.br/produtos/wp-json/wp/v2/media?parent=6862"
       }
     ],
     "curies": [
       {
         "name": "wp",
         "href": "https://api.w.org/{rel}",
         "templated": true
       }
     ]
   }
 },
Disponível em "http://doc.seade.gov.br/index.php?title=API-PRODUTOS&oldid=403"