2.0info: 2.6.0 Inquilinos description: Serviço responsável pelo gerenciamento de criação de CRM na Platform. x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: tenant contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/tenantsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listTenantName: post: description: Retorna o nome dos tenants do CRM com base nos filtros x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: integrationDefault: #/definitions/integrationDefaultEnum active: type: boolean description: Ativo responses: 200: description: Ok schema: type: object required: – tenantNames properties: tenantNames: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome dos tenants do CRM com base nos filtros x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: integrationDefault: #/definitions/integrationDefaultEnum active: type: boolean description: Ativo responses: 200: description: Ok schema: type: object required: – tenantNames properties: tenantNames: type: string description: default: description: Error response schema: #/definitions/genericError /healthcheck: post: description: Health Check desse serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/statusHealthcheckEnum default: description: Error response schema: #/definitions/genericError get: description: Health Check desse serviço x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/statusHealthcheckEnum default: description: Error response schema: #/definitions/genericError /tenantExist: post: description: Retorna se o tenant existe no CRM x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – exist properties: exist: type: boolean description: default: description: Error response schema: #/definitions/genericError get: description: Retorna se o tenant existe no CRM x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – exist properties: exist: type: boolean description: default: description: Error response schema: #/definitions/genericError /getTenant: post: description: Retorna os dados do tenant que está fazendo a requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: #/definitions/tenant default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados do tenant que está fazendo a requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant responses: 200: description: Ok schema: #/definitions/tenant default: description: Error response schema: #/definitions/genericErrordefinitions: statusHealthcheckEnum: type: string enum: – UP – DOWN integrationDefaultEnum: type: string enum: – ERP_SENIOR – ERP_SENIOR_XT – ERP_NOVASOFT – ERP_SENIOR_X – ERP_MEGA_XT modulesCrmEnum: type: string enum: – ACCOUNT – COLLABORATIVE – OPPORTUNITIES – OCCURRENCES – CONTRACTS – CAMPAIGNS – EXPENSES – ANALYTICS – RECORDS – RESEARCHES – AGRONOMY – QUICK_SALE – FINANCIAL stepEnum: type: string enum: – CREATE_IN_JAVA – CREATE_IN_PHP – CREATE_DEFAULT_USERS – CREATE_DEFAULT_ROLES – SYNC_USERS – CREATE_QUEUES_USER – SYNC_ROLES_AND_PERMISSIONS – CREATE_QUEUES_AUTH – CONFIGURE_CAMPAIGN – INTEGRATION_INITIAL_CHARGE stepStatusEnum: type: string enum: – PENDING – SKIPPED – FINISHED_SUCCESS – FINISHED_ERROR tenant: type: object required: – tenantName – sale properties: id: type: string description: format: uuid tenantName: type: string description: Nome do tenant companyName: type: string description: Nome da empresa sale: #/definitions/sale integrationDefault: #/definitions/integrationDefaultEnum tenantDomain: type: string description: Domino do Tenant deactivationDate: type: string description: Data de desativação format: date-time active: type: boolean description: Ativo internalImplantation: type: boolean description: Se foi implantando internamente steps: type: array items: #/definitions/step description: Passos para cria o tenant createdBy: type: string description: createdAt: type: string description: format: date-time changedBy: type: string description: changedAt: type: string description: format: date-time sale: type: object required: – name – modules – createActiveUsers – active properties: id: type: string description: format: uuid slug: type: string description: Slug do pacote name: type: string description: Nome do empacotamento modules: type: array items: #/definitions/modulesCrmEnum description: Módulos do CRM createActiveUsers: type: boolean description: Criar usuários ativos active: type: boolean description: Empacotamento ativo rolesDefault: type: array items: #/definitions/saleDefaultRole description: Papeis padrões saleDefaultRole: type: object required: – id – roleDefault properties: id: type: string description: format: uuid sale: #/definitions/sale roleDefault: #/definitions/roleDefault roleDefault: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome step: type: object required: – name – status – rank properties: id: type: string description: format: uuid name: #/definitions/stepEnum errorLog: type: string description: Log de erro status: #/definitions/stepStatusEnum rank: type: integer description: Ordenação tenant: #/definitions/tenant genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE