API: domain_business_partner
PRODUTO: Dokfile DF-e
Funcionalidade: Busca a lista de todas as prefeituras suportadas pela Dokfile.
Método: GET
Retorno: JSON
Parâmetro
Token
Neste parâmetro deve ser passado seu token de acesso para autenticar o uso da API.
Exemplo e Estrutura de uma chamada:
Método:
URL: https://Base/domain_product_nfse_query_provider/DOMAIN_ID?domain_id=as_resource&secret_access_key=true&authorization=SEUTOKEN
Base: Domínio da api (entre em contato para receber o domínio)
API: /domain_product_nfse_query_provider
Código da empresa: /DOMAIN_ID
Token: &authorization=SEUTOKEN
Exemplo de Retorno
{
"id": "862f8e2a-d2f7-11e8-aca9-026a5d9a0ad1",
"cd": 0,
"success": true,
"list": [
{ ... },
{
"ibge_city_code": "3550308",
"nfse_provider": "SP/SAO_PAULO",
"software_house": "PRODAM",
"software_house_url": "http://www.prefeitura.sp.gov.br/cidade/secretarias/inovacao/prodam/",
"model": "proprietário",
"version": "Versao_1.00",
"ws_production_query": "https://nfe.prefeitura.sp.gov.br/ws/lotenfe.asmx",
"ws_homologation_query": "https://nfe.prefeitura.sp.gov.br/ws/lotenfe.asmx",
"ws_home": "https://nfe.prefeitura.sp.gov.br/ws/lotenfe.asmx?WSDL",
"provider_call_name": "SP_Sao_Paulo",
"need_siginup": 0,
"siginup_url": null,
"need_partner_register": 0,
"support_query_out_files": 1,
"support_query_in_files": 1
},
{ ... }
]
}
Onde:
id
identificador da operação
cd
código de erro
- 0: requisição feita com sucesso;
- maior que 0: analisar mensagem exibida em “error” para validar problema ocorrido;
success
Indica se operação realizada ocorreu bem ou falhou.
list
Indica onde fica toda a lista das prefeituras retornados.
- ibge_city_code: código IBGE da cidade;
- nfse_provider: nome da prefeitura;
- software_house: nome da Software House;
- software_house_url: link para Software House;
- model: padrão de comunicação;
- version: indica se parceiro é um fornecedor;
- ws_production_query: link do web service de produção;
- ws_homologation_query: link do web service de homologação;
- ws_home: endereço da descrição do web service;
- provider_call_name: nome do provedor;
- need_siginup: necessidade do tomador ter cadastro na prefeitura (0 = não; 1 = sim);
- siginup_url: endereço do cadastro;
- need_partner_register: necessidade do cadastro do parceiro;
- support_query_out_files: permite consultar notas de serviço prestado;
- support_query_in_files: permite consultar notas de serviço tomado;
Utilidade
Esta API tem por finalidade buscar a lista de prefeituras suportadas para consulta de Nota Fiscal de Serviço eletrônica(NFS-e), muito útil quando usada em conjunto com a API domain_product_nfse_query_provider_bind para realizar a integração de um parceiro e uma prefeitura.