API SEBRAE ndash MEacuteTODOS PARA INTEGRACcedilAtildeO COM APLATAFORMA
Versatildeo 10
Brasiacutelia
2017
Manual API SEBRAE
HISTOacuteRICO DE VERSOtildeES
Data Versatildeo Descriccedilatildeo Autor
17012017 10 Criaccedilatildeo Cast Group
Sumaacuterio
1 INTRODUCcedilAtildeO52 SERVICcedilOS6
21 Formatos de Entrega721 URL do serviccedilo7
3FERRAMENTAS E SITES DE APOIO731 GraphQL 732 Postman733 IBGE7
4MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA841 GRAPHQL8411Consultar Porte da Empresa8
4111 Exemplo do json usando HTTP Post84112 Atributos de entrada84113 Possiacuteveis Atributos retornados84114 Exemplo Possiacutevel JSON de retorno94115 Possiacutevel exemplo utilizando Postman10
412Buscar CNPJrsquos na base de dados104121 Atributos de entrada114122 Atributos retornados114123 Exemplo de JSON de retorno114124 Exemplo utilizando Postman 12
413Buscar remuneraccedilatildeo meacutedia Trabalhador134131 Exemplo do json usando HTTP Post134132 Atributos de entrada134133 Atributos retornados134134 Exemplo de JSON de retorno134135 Exemplo utilizando Postman13
414Buscar quantidade de empresas por CNAE ou Regiatildeo 144141 Exemplo do json usando HTTP Post144142 Atributos de entrada144143 Atributos retornados154144 Exemplo de JSON de retorno154145 Exemplo utilizando Postman15
415Buscar quantidade meacutedia de trabalhadores por Regiatildeo154151 Exemplo do json usando HTTP Post164152 Atributos de entrada164153 Atributos retornados164154 Exemplo de JSON de retorno164155 Exemplo utilizando Postman16
1 INTRODUCcedilAtildeO
Este documento tem a finalidade de descrever os serviccedilos disponiacuteveis na API do SEBRAE
que foram criados para viabilizar a integraccedilatildeo com os dados disponiacutevel na Plataforma
possibilitando orientar o desenvolvimento de novas integraccedilotildees com a Plataforma a partir da
API SEBRAE A troca de dados ocorre em formato JSON e o fato desse modelo que eacute
independente de linguagem de programaccedilatildeo e representa os dados de maneira alinhada aos
conceitos universais de programaccedilatildeo
Figura 1 - Visatildeo Geral da Arquitetura da Soluccedilatildeo
Fonte httpswwwhowtographqlcombasics3-big-picture
2 SERVICcedilOS
Uma arquitetura que utiliza serviccedilos tem a finalidade de garantir a reutilizaccedilatildeo das regras de
negoacutecio encapsulando-as em serviccedilos distintos Os serviccedilos aqui descritos objetivam
viabilizar a integraccedilatildeo da Plataforma por meio da API Sebrae que garantiraacute uma integraccedilatildeo
mais simples e centralizada
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
Manual API SEBRAE
HISTOacuteRICO DE VERSOtildeES
Data Versatildeo Descriccedilatildeo Autor
17012017 10 Criaccedilatildeo Cast Group
Sumaacuterio
1 INTRODUCcedilAtildeO52 SERVICcedilOS6
21 Formatos de Entrega721 URL do serviccedilo7
3FERRAMENTAS E SITES DE APOIO731 GraphQL 732 Postman733 IBGE7
4MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA841 GRAPHQL8411Consultar Porte da Empresa8
4111 Exemplo do json usando HTTP Post84112 Atributos de entrada84113 Possiacuteveis Atributos retornados84114 Exemplo Possiacutevel JSON de retorno94115 Possiacutevel exemplo utilizando Postman10
412Buscar CNPJrsquos na base de dados104121 Atributos de entrada114122 Atributos retornados114123 Exemplo de JSON de retorno114124 Exemplo utilizando Postman 12
413Buscar remuneraccedilatildeo meacutedia Trabalhador134131 Exemplo do json usando HTTP Post134132 Atributos de entrada134133 Atributos retornados134134 Exemplo de JSON de retorno134135 Exemplo utilizando Postman13
414Buscar quantidade de empresas por CNAE ou Regiatildeo 144141 Exemplo do json usando HTTP Post144142 Atributos de entrada144143 Atributos retornados154144 Exemplo de JSON de retorno154145 Exemplo utilizando Postman15
415Buscar quantidade meacutedia de trabalhadores por Regiatildeo154151 Exemplo do json usando HTTP Post164152 Atributos de entrada164153 Atributos retornados164154 Exemplo de JSON de retorno164155 Exemplo utilizando Postman16
1 INTRODUCcedilAtildeO
Este documento tem a finalidade de descrever os serviccedilos disponiacuteveis na API do SEBRAE
que foram criados para viabilizar a integraccedilatildeo com os dados disponiacutevel na Plataforma
possibilitando orientar o desenvolvimento de novas integraccedilotildees com a Plataforma a partir da
API SEBRAE A troca de dados ocorre em formato JSON e o fato desse modelo que eacute
independente de linguagem de programaccedilatildeo e representa os dados de maneira alinhada aos
conceitos universais de programaccedilatildeo
Figura 1 - Visatildeo Geral da Arquitetura da Soluccedilatildeo
Fonte httpswwwhowtographqlcombasics3-big-picture
2 SERVICcedilOS
Uma arquitetura que utiliza serviccedilos tem a finalidade de garantir a reutilizaccedilatildeo das regras de
negoacutecio encapsulando-as em serviccedilos distintos Os serviccedilos aqui descritos objetivam
viabilizar a integraccedilatildeo da Plataforma por meio da API Sebrae que garantiraacute uma integraccedilatildeo
mais simples e centralizada
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
Sumaacuterio
1 INTRODUCcedilAtildeO52 SERVICcedilOS6
21 Formatos de Entrega721 URL do serviccedilo7
3FERRAMENTAS E SITES DE APOIO731 GraphQL 732 Postman733 IBGE7
4MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA841 GRAPHQL8411Consultar Porte da Empresa8
4111 Exemplo do json usando HTTP Post84112 Atributos de entrada84113 Possiacuteveis Atributos retornados84114 Exemplo Possiacutevel JSON de retorno94115 Possiacutevel exemplo utilizando Postman10
412Buscar CNPJrsquos na base de dados104121 Atributos de entrada114122 Atributos retornados114123 Exemplo de JSON de retorno114124 Exemplo utilizando Postman 12
413Buscar remuneraccedilatildeo meacutedia Trabalhador134131 Exemplo do json usando HTTP Post134132 Atributos de entrada134133 Atributos retornados134134 Exemplo de JSON de retorno134135 Exemplo utilizando Postman13
414Buscar quantidade de empresas por CNAE ou Regiatildeo 144141 Exemplo do json usando HTTP Post144142 Atributos de entrada144143 Atributos retornados154144 Exemplo de JSON de retorno154145 Exemplo utilizando Postman15
415Buscar quantidade meacutedia de trabalhadores por Regiatildeo154151 Exemplo do json usando HTTP Post164152 Atributos de entrada164153 Atributos retornados164154 Exemplo de JSON de retorno164155 Exemplo utilizando Postman16
1 INTRODUCcedilAtildeO
Este documento tem a finalidade de descrever os serviccedilos disponiacuteveis na API do SEBRAE
que foram criados para viabilizar a integraccedilatildeo com os dados disponiacutevel na Plataforma
possibilitando orientar o desenvolvimento de novas integraccedilotildees com a Plataforma a partir da
API SEBRAE A troca de dados ocorre em formato JSON e o fato desse modelo que eacute
independente de linguagem de programaccedilatildeo e representa os dados de maneira alinhada aos
conceitos universais de programaccedilatildeo
Figura 1 - Visatildeo Geral da Arquitetura da Soluccedilatildeo
Fonte httpswwwhowtographqlcombasics3-big-picture
2 SERVICcedilOS
Uma arquitetura que utiliza serviccedilos tem a finalidade de garantir a reutilizaccedilatildeo das regras de
negoacutecio encapsulando-as em serviccedilos distintos Os serviccedilos aqui descritos objetivam
viabilizar a integraccedilatildeo da Plataforma por meio da API Sebrae que garantiraacute uma integraccedilatildeo
mais simples e centralizada
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
1 INTRODUCcedilAtildeO
Este documento tem a finalidade de descrever os serviccedilos disponiacuteveis na API do SEBRAE
que foram criados para viabilizar a integraccedilatildeo com os dados disponiacutevel na Plataforma
possibilitando orientar o desenvolvimento de novas integraccedilotildees com a Plataforma a partir da
API SEBRAE A troca de dados ocorre em formato JSON e o fato desse modelo que eacute
independente de linguagem de programaccedilatildeo e representa os dados de maneira alinhada aos
conceitos universais de programaccedilatildeo
Figura 1 - Visatildeo Geral da Arquitetura da Soluccedilatildeo
Fonte httpswwwhowtographqlcombasics3-big-picture
2 SERVICcedilOS
Uma arquitetura que utiliza serviccedilos tem a finalidade de garantir a reutilizaccedilatildeo das regras de
negoacutecio encapsulando-as em serviccedilos distintos Os serviccedilos aqui descritos objetivam
viabilizar a integraccedilatildeo da Plataforma por meio da API Sebrae que garantiraacute uma integraccedilatildeo
mais simples e centralizada
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
2 SERVICcedilOS
Uma arquitetura que utiliza serviccedilos tem a finalidade de garantir a reutilizaccedilatildeo das regras de
negoacutecio encapsulando-as em serviccedilos distintos Os serviccedilos aqui descritos objetivam
viabilizar a integraccedilatildeo da Plataforma por meio da API Sebrae que garantiraacute uma integraccedilatildeo
mais simples e centralizada
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
21 Formatos de Entrega
Devido a necessidade de facilidade para acesso agraves informaccedilotildees do Barramento da API atraveacutes
de vaacuterios tipos de plataforma tais como Plataformas Mobile (IOS Apple Google Android
Microsoft Windows Phone e outros sistemas (B2B) optou-se por fazer com que o barramento
seja responsaacutevel pela transformaccedilatildeo dos dados em 1 formato
As informaccedilotildees satildeo entregues em serviccedilos (endpoint) distintos listados abaixo
GRAPHQL - JSON ndash Javascript Object Notation
21 URL do serviccedilo
A url do serviccedilo consta no seguinte link httpsapiplataformasebraecombrgraphqlA ferramento do GraphQL conteacutem uma estrutura interativa que pode ser acessada pelaseguinte url httpsapiplataformasebraecombrgraphiql
3 FERRAMENTAS E SITES DE APOIO
31 GraphQL
Os serviccedilos disponibilizados em GRAPHQL que eacute uma linguagem de querys para APIs A qual
responde exatamente o que vocecirc pedir e nada a mais Ela possui um uacutenico endpoint que recebe o
HTTP Request baseado no meacutetodo que deveraacute ser utilizado Para mais informaccedilotildees
httpgraphqlorg
32 Postman
Para a melhor demonstraccedilatildeo dos serviccedilos seraacute utilizada algumas imagens da ferramenta Postman
essa que eacute uma poderosa plataforma GUI para construccedilatildeo de API facilitando para que o
desenvolvimento seja raacutepido
33 IBGE
Os dados referentes aos coacutedigos dos municiacutepios utilizam os mesmos que satildeo fornecidos pelo
IBGE e podem ser encontrados no seguinte site
httpswwwibgegovbrgeociencias-novoportalorganizacao-do-territorioestrutura-
territorial15761-areas-dos-municipioshtmlampt=destaques
Os dados referentes aos coacutedigos dos CNAErsquos utilizam os mesmos que satildeo fornecidos pelo IBGE e
podem ser encontrados no seguinte site
httpsconclaibgegovbrbusca-online-cnaehtml
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4 MEacuteTODOS PARA INTEGRACcedilAtildeO COM A PLATAFORMA
41 GRAPHQL
As requisiccedilotildees GRAPH no Header da requisiccedilatildeo HTTP deveratildeo ser especificados o seguinte
atributoContent-Type Para o retorno e envio do conteuacutedo em JSON deveratildeo ser informados
ldquoapplicationjson charset=utf-8rdquo Desta forma a API retornaraacute o conteuacutedo de acordo com o
que for solicitado na requisiccedilatildeo Todas as requisiccedilotildees devem ser do tipo POST
Isto garante ao desenvolvedor a flexibilidade de alterar somente o Header sem maiores
alteraccedilotildees no desenvolvimento da comunicaccedilatildeo com a API
Uma grande peculiaridade e vantagem do GRAHPQL eacute que no HTTP response ele retorna
apenas o que foi passado para retorno nos exemplos dos meacutetodos eacute exemplificado
411 Consultar Porte da Empresa
Tipo POST
Path graphql
Consulta que retorna os dados da empresa a partir de um CNPJ informado
4111 Exemplo do json usando HTTP Post
query obterEmpresasPorCnpj(cnpj 000116000120) cep cnpj codCnae
codMunicipioIbge dataAbertura dadosFaturamentos ano ativo descricao municipio nomeFantasia razaoSocial uf
4112 Atributos de entrada
Nome Descriccedilatildeo Tipo Obrigatoacuterio Exemplo de dado
cnpj CNPJ da Empresa String Sim cnpj
4113 Possiacuteveis Atributos retornados
O meacutetodo retorna a abstraccedilatildeo dos dados de uma empresa com os possiacuteveis atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cep CEP da Empresa String 2720100cnpj CNPJ da Empresa String 000116000120
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
codCnae Coacutedigo Cnae da Empresa Inteiro 8630503
codMunicipioIbge Coacutedigo Municiacutepio em que seencontra a Empresa String 3550308
dataAbertura Data da Abertura da Empresa String 1970-01-02
dadosFaturamentosApresenta uma seacuterie histoacuterica daempresa do ano de 2010 ao de
2014DadoFaturamento
ano 2010ativo truedescriccedilatildeo
Microoempresa
municipio Municiacutepio em que se encontra aEmpresa String
nomeFantasia Nome Fantasia da Empresa String AmbulatoacuterioXYZ
razaoSocial Razatildeo Social da Empresa StringAmbulatoacuterio
XYZ SC LTDAME
uf Estado em que se encontra aEmpresa String SP
4114 Exemplo Possiacutevel JSON de retorno
dataobterEmpresasPorCnpj[cep2720100cnpj000116000120codCnae8630503codMunicipioIbge3550308dataAbertura1970-01-02dadosFaturamentos[ano2010ativotruedescricaoMicroempresa
ano2011ativotruedescricaoMicroempresa
ano2012ativotruedescricaoMicroempresa
ano2013ativotruedescricaoMicroempresa
ano2014ativotruedescricaoMicroempresa
]municipioSatildeo PaulonomeFantasiaNatildeo informadorazaoSocialAMBULATORIO MEDICO GUIDO FELIX ESCOBAR SC LTDA - MEufSP
]
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4115 Possiacutevel exemplo utilizando Postman
412 Buscar CNPJrsquos na base de dados
Tipo POST
Path graphql
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4121 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
qtdElementos Quantidade de CNPJ que desejaretornar limitado a 50 Inteiro Sim 42
4122 Atributos retornados
O meacutetodo retorna uma lista de objetos de termos com os seguintes atributos
Nome Descriccedilatildeo Tipo Exemplo deDado
cnpj CNPJ da Empresa String 000116000120
4123 Exemplo de JSON de retorno
datagetEmpresasAleatorias[000618000151001871000120001639000191000802001688002027000113001891000362000802004784000802000363000681000198000211000124
]
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4124 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
413 Buscar remuneraccedilatildeo meacutedia Trabalhador
Tipo POST
Path graphql
4131 Exemplo do json usando HTTP Post
query obterRemuneracaoMediaCnaeRegiao(codCnae 4921301 uf AL
codMunicipioIbge 2704302)
4132 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 4921301
uf UF da localizaccedilatildeo do Trabalhador String Sim AL
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 2704302
4133 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a remuneraccedilatildeo meacutedia calculada
Nome Descriccedilatildeo Tipo Exemplo deDado
obterRemuneracaoMediaCnaeRegiao Valor da remuneraccedilatildeo meacutedia Float 2529488
4134 Exemplo de JSON de retorno
data
obterRemuneracaoMediaCnaeRegiao2529488
4135 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
414 Buscar quantidade de empresas por CNAE ou Regiatildeo
Tipo POST
Path graphql
4141 Exemplo do json usando HTTP Post
query qtdEmpresasPorCodCnaeOuRegiao(codCnae 8512100 ufSP cod
MunicipioIbge 4717020 cep 3550308)
4142 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dado
codCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador String Natildeo 3550308
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4143 Atributos retornados
O meacutetodo retorna a quantidade de empresas por cnae ou regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdEmpresasPorCodCnaeOuRegiao
Quantidade de Empresas deacordo com os parametros
passadosInteger 42
4144 Exemplo de JSON de retorno
data
qtdEmpresasPorCodCnaeOuRegiao42
4145 Exemplo utilizando Postman
415 Buscar quantidade meacutedia de trabalhadores por Regiatildeo
Tipo POST
Path graphql
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
4151 Exemplo do json usando HTTP Post
query qtdMediaTrabalhadorPorCnaeOuRegiao(codCnae 8512100 ufAL
codMunicipioIbge 2704302 cep 57240000)
4152 Atributos de entrada
Nome Descriccedilatildeo Tipo ObrigatoacuterioExemplo de
dadocodCnae Coacutedigo Cnae da Empresa Inteiro Sim 8512100
uf UF da localizaccedilatildeo da Empresa String Sim SPcep CEP da localizaccedilatildeo da Empresa String Natildeo 4717020
codMunicipioIbge Coacutedigo do Municiacutepio doTrabalhador Inteiro Natildeo 3550308
4153 Atributos retornados
O meacutetodo retorna o nome do meacutetodo com a quantidade meacutedia de trabalhadores por regiatildeo
Nome Descriccedilatildeo Tipo Exemplo deDado
qtdMediaTrabalhadorPorCnaeOuRegiao
Meacutedia de Trabalhadores porRegiatildeo Integer 42
4154 Exemplo de JSON de retorno
data
qtdMediaTrabalhadorPorCnaeOuRegiao5401
4155 Exemplo utilizando Postman
Top Related