-
-
Save messiahh/b8ad424a11cbea88d4ee9875920a6b0e to your computer and use it in GitHub Desktop.
test
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
swagger: "2.0" | |
info: | |
description: "Documentação da CRM API do Sebrae" | |
version: "1.0.0" | |
title: "Sebrae CRM API" | |
contact: | |
email: "diego@azuris.com.br" | |
# host: 'prsrvvm-jbch.pr.sebrae.com.br:8008' | |
# host: apphml.pr.sebrae.com.br | |
# basePath: /nan-api/mobile | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
paths: | |
"/crm-api/public/login/": | |
get: | |
tags: | |
- "CRM login" | |
summary: WS de login | |
description: WS de login | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
$ref: "#/definitions/Login" | |
"/crm-api/escolaridade/": | |
get: | |
tags: | |
- "CRM Escolaridade" | |
summary: Retorna uma lista de escolaridades | |
description: Busca todos as escolaridades | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Escolaridade" | |
"/crm-api/escolaridade/{id}/": | |
get: | |
tags: | |
- "CRM Escolaridade" | |
description: Retorna uma escolaridade | |
summary: Busca uma escolaridade pelo ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID da escolaridade | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: Escolaridade response | |
schema: | |
$ref: '#/definitions/Escolaridade' | |
"/crm-api/porte/": | |
get: | |
tags: | |
- "CRM Porte" | |
summary: Retorna uma lista de portes da empresa | |
description: Busca todos as opçoes de porte da empresa | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Porte" | |
"/crm-api/porte/{id}/": | |
get: | |
tags: | |
- "CRM Porte" | |
description: Retorna um porte | |
summary: Busca um porte por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do porte | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: Porte response | |
schema: | |
$ref: '#/definitions/Porte' | |
"/crm-api/rede-social/": | |
get: | |
tags: | |
- "CRM Rede Social" | |
summary: Retorna uma lista de rede social | |
description: Busca todos as opçoes de rede social | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/RedeSocial" | |
"/crm-api/rede-social/{id}/": | |
get: | |
tags: | |
- "CRM Rede Social" | |
description: Retorna uma rede social | |
summary: Busca uma rede social por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do porte | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: RedeSocial response | |
schema: | |
$ref: '#/definitions/RedeSocial' | |
"/crm-api/tipo-telefone/": | |
get: | |
tags: | |
- "CRM Tipo Telefone" | |
summary: Retorna uma lista dos tipo de telefone | |
description: Busca todos as opçoes do tipo de telefone | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/TipoTelefone" | |
"/crm-api/tipo-telefone/{id}/": | |
get: | |
tags: | |
- "CRM Tipo Telefone" | |
description: Retorna um tipo de telefone | |
summary: Busca um tipo de telefone por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do Tipo de telefone | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: TipoTelefone response | |
schema: | |
$ref: '#/definitions/TipoTelefone' | |
"/crm-api/tipo-vinculo/": | |
get: | |
tags: | |
- "CRM Tipo de Vinculo" | |
summary: Retorna uma lista dos tipo de vinculo | |
description: Busca todos as opçoes do tipo de vinculo | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/TipoVinculo" | |
"/crm-api/tipo-vinculo/{id}/": | |
get: | |
tags: | |
- "CRM Tipo de Vinculo" | |
description: Retorna um tipo de vinculo | |
summary: Busca um tipo de vinculo por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do tipo de vinculo | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: TipoVinculo response | |
schema: | |
$ref: '#/definitions/TipoVinculo' | |
"/crm-api/enquadramento/": | |
get: | |
tags: | |
- "CRM Enquadramento" | |
summary: Retorna uma lista dos enquadramentos | |
description: Busca todos as opçoes do enquadramento | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Enquadramento" | |
"/crm-api/enquadramento/{id}/": | |
get: | |
tags: | |
- "CRM Enquadramento" | |
description: Retorna um enquadramento | |
summary: Busca um enquadramento por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do enquadramento | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: Enquadramento response | |
schema: | |
$ref: '#/definitions/Enquadramento' | |
"/crm-api/setor/": | |
get: | |
tags: | |
- "CRM Setor" | |
summary: Retorna a lista de setores | |
description: Busca todos as opçoes do setor | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Setor" | |
"/crm-api/setor/{id}/": | |
get: | |
tags: | |
- "CRM Setor" | |
description: Retorna um setor | |
summary: Busca um setor por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do setor | |
required: true | |
type: integer | |
responses: | |
200: | |
description: Setor response | |
schema: | |
$ref: '#/definitions/Setor' | |
"/crm-api/profissao/": | |
get: | |
tags: | |
- "CRM Setor" | |
summary: Retorna uma lista de profissão | |
description: Busca todos as opçoes da profissão | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Profissao" | |
"/crm-api/profissao/{id}/": | |
get: | |
tags: | |
- "CRM Setor" | |
description: Retorna uma profissão | |
summary: Busca um setor por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID da profissão | |
required: true | |
type: integer | |
responses: | |
200: | |
description: Profissao response | |
schema: | |
$ref: '#/definitions/Profissao' | |
## api salomão | |
"/crm-api/ficou-sabendo/": | |
get: | |
tags: | |
- "CRM Ficou Sabendo" | |
summary: Retorna uma lista da origem da informacao | |
description: Busca todas as listas da origem da informacao | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/FicouSabendo" | |
"/crm-api/ficou-sabendo/{id}/": | |
get: | |
tags: | |
- "CRM ficou-sabendo-id" | |
description: Retorna uma lista de origem da informacao | |
summary: Busca um ficou sabendo por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do grupo | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: grupo response | |
schema: | |
$ref: '#/definitions/FicouSabendo' | |
"/crm-api/cnae/": | |
get: | |
tags: | |
- "CRM Cnae" | |
summary: Retorna uma lista de Cnae | |
description: Busca todas as opções de cnae | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Cnae" | |
"/crm-api/cnae/{id}/": | |
get: | |
tags: | |
- "CRM cnae/id" | |
description: Retorna o codigo cnae | |
summary: Busca um codigo cnae | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do cnae | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: Cnae response | |
schema: | |
$ref: '#/definitions/Cnae' | |
"/crm-api/natureza-juridica/": | |
get: | |
description: Busca tipos de natureza juridica | |
summary: Retorna uma lista de tipos de natureza juridica | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/NatureJuridica" | |
"/crm-api/natureza-juridica/{id}": | |
get: | |
description: Retorna um id de natureza juridica | |
summary: Busca pelo ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID da natureza juridica | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: NatureJuridica response | |
schema: | |
$ref: "#/definitions/NatureJuridica" | |
"/crm-api/grupo/": | |
get: | |
tags: | |
- "CRM Grupo" | |
summary: Retorna uma lista de grupos da empresa | |
description: Busca todos os grupos da empresa | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Grupo" | |
"/crm-api/grupo/{id}/": | |
get: | |
tags: | |
- "CRM Grupo" | |
description: Retorna um grupo | |
summary: Busca um grupo por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do grupo | |
required: true | |
type: integer | |
responses: | |
'200': | |
description: Grupo response | |
schema: | |
$ref: '#/definitions/Grupo' | |
## api salomão | |
"/crm-api/agente/": | |
get: | |
tags: | |
- "CRM Agente" | |
summary: Retorna uma lista de agente | |
description: Busca todos os agentes pelo filtro | |
produces: | |
- application/json | |
parameters: | |
- name: codigo | |
in: query | |
description: código do agente | |
required: false | |
default: 50 | |
minimum: 1 | |
type: integer | |
format: int64 | |
- name: nome | |
in: query | |
description: Nome do agente | |
minimum: 4 | |
required: false | |
type: string | |
- name: email | |
in: query | |
description: E-mail do agente | |
minimum: 4 | |
required: false | |
type: string | |
- name: telefone | |
in: query | |
description: Telefone do agente | |
minimum: 4 | |
required: false | |
type: string | |
- name: cpf_cnpj | |
in: query | |
description: CPF/CNPJ do agente | |
minimum: 4 | |
required: false | |
type: string | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Agente" | |
examples: | |
application/json: | |
- codigo: 119877 | |
nome: "HELENA NOGUEIRA WISENFATH" | |
documentId: "830.580.369-49" | |
email: null | |
obs: null | |
tipo: "PF" | |
telefonePrincipal: "0" | |
localizacao: "Paiçandu - PR" | |
nomeFantasia: null | |
- codigo: 751423 | |
nome: DANIELLA ABRANTES GITTI WISENTAINER | |
documentId: 007.906.279-22 | |
email: atendimento@sebraepr.com.br | |
obs: Carga MEI 25/06/2015 - Sebrae NA | |
tipo: PF | |
telefonePrincipal: '0' | |
localizacao: São José Dos Pinhais - PR | |
nomeFantasia: null | |
- codigo: 16837 | |
nome: WISE SYSTEMS CONSULTORIA E ASSESSORIA EM INFORMATICA LTDA | |
documentId: 03.443.886/0001-36 | |
email: atendimento@sebraepr.com.br | |
obs: null | |
tipo: PJ | |
telefonePrincipal: '0' | |
localizacao: Curitiba - PR | |
nomeFantasia: WISESYSTEMS | |
"/crm-api/agente/paged/": | |
get: | |
tags: | |
- "CRM Agente" | |
summary: Retorna uma lista de agente paginados | |
description: Busca todos os agentes pelo filtro com paginação | |
produces: | |
- application/json | |
parameters: | |
- name: cpf_cnpj | |
in: query | |
description: CPF/CNPJ do agente | |
minimum: 4 | |
required: false | |
type: string | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Agente" | |
examples: | |
application/json: | |
- codigo: 119877 | |
nome: "HELENA NOGUEIRA WISENFATH" | |
documentId: "830.580.369-49" | |
email: null | |
obs: null | |
tipo: "PF" | |
telefonePrincipal: "0" | |
localizacao: "Paiçandu - PR" | |
nomeFantasia: null | |
- codigo: 751423 | |
nome: DANIELLA ABRANTES GITTI WISENTAINER | |
documentId: 007.906.279-22 | |
email: atendimento@sebraepr.com.br | |
obs: Carga MEI 25/06/2015 - Sebrae NA | |
tipo: PF | |
telefonePrincipal: '0' | |
localizacao: São José Dos Pinhais - PR | |
nomeFantasia: null | |
- codigo: 16837 | |
nome: WISE SYSTEMS CONSULTORIA E ASSESSORIA EM INFORMATICA LTDA | |
documentId: 03.443.886/0001-36 | |
email: atendimento@sebraepr.com.br | |
obs: null | |
tipo: PJ | |
telefonePrincipal: '0' | |
localizacao: Curitiba - PR | |
nomeFantasia: WISESYSTEMS | |
"/crm-api/agente/{id}/": | |
get: | |
tags: | |
- "CRM Agente" | |
description: Retorna um agente | |
summary: Busca um agente por ID | |
produces: | |
- application/json | |
parameters: | |
- name: id | |
in: path | |
description: ID do agente | |
required: true | |
type: integer | |
responses: | |
200: | |
description: Sucesso | |
schema: | |
type: "array" | |
items: | |
$ref: "#/definitions/Agente" | |
examples: | |
application/json: | |
- codigo: 119877 | |
nome: "HELENA NOGUEIRA WISENFATH" | |
documentId: "830.580.369-49" | |
email: null | |
obs: null | |
tipo: "PF" | |
telefonePrincipal: "0" | |
localizacao: "Paiçandu - PR" | |
nomeFantasia: null | |
- codigo: 751423 | |
nome: DANIELLA ABRANTES GITTI WISENTAINER | |
documentId: 007.906.279-22 | |
email: atendimento@sebraepr.com.br | |
obs: Carga MEI 25/06/2015 - Sebrae NA | |
tipo: PF | |
telefonePrincipal: '0' | |
localizacao: São José Dos Pinhais - PR | |
nomeFantasia: null | |
- codigo: 16837 | |
nome: WISE SYSTEMS CONSULTORIA E ASSESSORIA EM INFORMATICA LTDA | |
documentId: 03.443.886/0001-36 | |
email: atendimento@sebraepr.com.br | |
obs: null | |
tipo: PJ | |
telefonePrincipal: '0' | |
localizacao: Curitiba - PR | |
nomeFantasia: WISESYSTEMS | |
definitions: | |
## api salomão | |
FicouSabendo: | |
description: objeto ficou-sabendo | |
type: object | |
properties: | |
codigo: | |
description: codigo da lista de origem da informacao | |
type: integer | |
descricao: | |
description: descricao ficou-sabendo | |
type: string | |
Cnae: | |
description: Objeto do cnae | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do cnae | |
type: integer | |
descricao: | |
description: Descricao do cnae | |
type: string | |
cnae: | |
description: Codigo do cnae | |
type: string | |
NatureJuridica: | |
description: Objeto da natureza juridica | |
type: "object" | |
properties: | |
codigo: | |
description: codigo da natureza | |
type: string | |
descricao: | |
description: Descrição da natureza | |
type: string | |
codigoGrupo: | |
description: Codigo do grupo | |
type: integer | |
descricaoGrupo: | |
description: Descrição/nome do grupo da natureza | |
type: string | |
Grupo: | |
description: Objeto do grupo | |
type: object | |
properties: | |
codigo: | |
description: codigo do grupo | |
type: integer | |
descricao: | |
description: descricao do grupo | |
type: string | |
## api salomão | |
Agente: | |
description: Objeto do agente | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do agente | |
type: integer | |
nome: | |
description: Nome do agente | |
type: string | |
documentId: | |
description: CPF/CNPJ do agente | |
type: string | |
nome: | |
description: Nome do agente | |
type: string | |
email: | |
description: E-mail do agente | |
type: string | |
obs: | |
description: Observação do agente | |
type: string | |
telefonePrincipal: | |
description: Telefone principal do agente | |
type: string | |
localizacao: | |
description: Localização do agente | |
type: string | |
state: | |
description: Status do agente | |
type: object | |
properties: | |
codigo: | |
description: Código do agente | |
type: integer | |
descricao: | |
description: Código do agente | |
type: integer | |
tipo: | |
description: Tipo do agente (PF/PJ) | |
type: string | |
agenteAtualizacao: | |
description: Status do agente | |
type: object | |
properties: | |
codigo: | |
description: Código do agente | |
type: integer | |
nome: | |
description: Nome do agente | |
type: integer | |
formatedDate: | |
description: Data da ultima atualização do agente | |
type: string | |
format: dateTime | |
dataAberturaNascimento: | |
description: Data da abertura/nascimento do agente | |
type: string | |
format: dateTime | |
dataFechamentoFalecimento: | |
description: Data da fechamento/falecimento do agente | |
type: string | |
format: dateTime | |
indicadores: | |
description: Indicadores do agente | |
type: object | |
properties: | |
emailMarketing: | |
description: Código do agente | |
type: boolean | |
boletim: | |
description: Boletim do agente | |
type: boolean | |
emailIncorreto: | |
description: E-mail incorreto do agente | |
type: boolean | |
enderecoIncorreto: | |
description: Endereço incorreto do agente | |
type: boolean | |
falecimentoFechamento: | |
description: Agente Falecido ou fechado | |
type: boolean | |
clienteExcluido: | |
description: Agente excluido | |
type: boolean | |
motivoExclusao: | |
description: Motivo da exclusão do agente | |
type: string | |
completudeCadastro: | |
description: percentual de preenchimento do agente | |
type: integer | |
telefones: | |
type: array | |
items: | |
$ref: '#/definitions/Telefone' | |
enderecos: | |
type: array | |
items: | |
$ref: '#/definitions/Endereco' | |
nomeFantasia: | |
description: Nome fantasia do agente | |
type: string | |
Endereco: | |
description: Objeto do telefone | |
type: "object" | |
properties: | |
codigo: | |
type: integer | |
description: código do endereco | |
logradouro: | |
type: object | |
description: Numero do telefone | |
properties: | |
codigo: | |
type: string | |
descricao: | |
type: string | |
bairro: | |
type: object | |
description: Numero do telefone | |
properties: | |
codigo: | |
type: string | |
descricao: | |
type: string | |
localidade: | |
type: object | |
description: Numero do telefone | |
properties: | |
codigo: | |
type: string | |
descricao: | |
type: string | |
numero: | |
type: string | |
complemento: | |
type: string | |
cep: | |
type: integer | |
estado: | |
type: string | |
pais: | |
type: string | |
principal: | |
type: boolean | |
recebeCorrespondencia: | |
type: boolean | |
incorreto: | |
type: boolean | |
estrangeiro: | |
type: boolean | |
geoLocalizacao: | |
type: object | |
properties: | |
latitude: | |
type: string | |
longitude: | |
type: string | |
tipoLocalizacao: | |
type: string | |
Telefone: | |
description: Objeto do telefone | |
type: "object" | |
properties: | |
codigo: | |
type: integer | |
description: código do telefone | |
telefone: | |
type: string | |
description: Numero do telefone | |
principal: | |
type: boolean | |
description: Indica se é o telefone principal do telefone | |
recebeLigacao: | |
type: boolean | |
description: Aceita receber ligação | |
recebeSMS: | |
type: boolean | |
description: Aceita receber sms | |
estrangeiro: | |
type: boolean | |
description: Indica se é estrangeiro | |
tipoTelefone: | |
$ref: "#/definitions/TipoTelefone" | |
Profissao: | |
description: Objeto do setor | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do setor | |
type: integer | |
descricao: | |
description: Descrição/nome do setor | |
type: string | |
Setor: | |
description: Objeto do setor | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do setor | |
type: integer | |
descricao: | |
description: Descrição/nome do setor | |
type: string | |
Enquadramento: | |
description: Objeto do enquadramento | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do enquadramento | |
type: integer | |
descricao: | |
description: Descrição/nome do enquadramento | |
type: string | |
TipoVinculo: | |
description: Objeto do tipo de vinculo | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do tipo de vinculo | |
type: integer | |
descricao: | |
description: Descrição/nome do tipo de vinculo | |
type: string | |
TipoTelefone: | |
description: Objeto do tipo de telefone | |
type: "object" | |
properties: | |
codigo: | |
description: codigo do tipo de telefone | |
type: integer | |
descricao: | |
description: Descrição/nome do tipo de telefone | |
type: string | |
RedeSocial: | |
description: Objeto da rede social | |
type: "object" | |
properties: | |
codigo: | |
description: codigo da rede social | |
type: integer | |
descricao: | |
description: Descrição da rede social | |
type: string | |
Porte: | |
description: Objeto do porte | |
type: "object" | |
properties: | |
codigo: | |
description: codigo da natureza | |
type: integer | |
descricao: | |
description: Descrição da natureza | |
type: string | |
Escolaridade: | |
description: Objeto de usuario(login) | |
type: "object" | |
properties: | |
codigo: | |
description: codigo da escolaridade | |
type: integer | |
descricao: | |
description: Descrição da escolaridade/nome | |
type: string | |
Login: | |
description: Objeto de usuario(login) | |
type: "object" | |
properties: | |
accessToken: | |
description: Token do usuário | |
type: "string" | |
usuario: | |
type: "object" | |
properties: | |
codigo: | |
description: Código | |
type: "string" | |
nome: | |
description: nome do usuário | |
type: "string" | |
email: | |
description: email do usuário | |
type: "string" | |
# Added by API Auto Mocking Plugin | |
host: virtserver.swaggerhub.com | |
basePath: /messiahh/crm-api/1.0.0 | |
# Added by API Auto Mocking Plugin | |
schemes: | |
- https | |
- http |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment