SoftExpertAPI 1.4.8

There is a newer version of this package available.
See the version list below for details.
dotnet add package SoftExpertAPI --version 1.4.8
                    
NuGet\Install-Package SoftExpertAPI -Version 1.4.8
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SoftExpertAPI" Version="1.4.8" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SoftExpertAPI" Version="1.4.8" />
                    
Directory.Packages.props
<PackageReference Include="SoftExpertAPI" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SoftExpertAPI --version 1.4.8
                    
#r "nuget: SoftExpertAPI, 1.4.8"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SoftExpertAPI@1.4.8
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SoftExpertAPI&version=1.4.8
                    
Install as a Cake Addin
#tool nuget:?package=SoftExpertAPI&version=1.4.8
                    
Install as a Cake Tool

SoftExpertAPI

<p align="center"> <img src="src/120.png" alt="SoftExpert Logo" width="100px" height="100px"> <img src="src/dotnet_logo.png" alt="Dotnet Logo" width="180px" height="100px"> </p>

SoftExpertAPI é uma biblioteca em .NET / C# que abstrai a comunicação SOAP e REST com a API do SoftExpert SE Suite.
Esta biblioteca não está completa e será desenvolvida conforme necessidades e pedidos.

Direitos reservados a https://www.softexpert.com/

Documentação original: https://documentation.softexpert.com/en/integration/index.html
Documentação original (nova versão): https://developer.softexpert.com/docs/data-integration/getting-started/platform-overview/

Contato: hudsonventura@outlook.com

Obs.: Testado no SoftExpert 2.1.4.x

Get Started

dotnet add package SoftExpertAPI
using SoftExpertAPI;

Pacote NuGet: https://www.nuget.org/packages/SoftExpertAPI/

Instanciação

A configuração e instanciação das classes estão documentadas em:

docs/Instanciacao.md

Resumo:

SoftExpertAPI.Configurations configs = new Configurations()
{
    baseUrl = "https://se.dominio.com.br",
    login = "usuario",
    pass = "senha",
    domain = "SE Suite",
    token = "SEU_TOKEN",
    // downloader = minhaImplementacaoIFileDownload, // opcional: anexos em diretório controlado
};
SoftExpertWorkflowApi wfAPI = new SoftExpertWorkflowApi(configs);

Exemplo rápido

try
{
    string WorkflowID = wfAPI.newWorkflow("CCF", "Teste de integração", "sistema.teste");
}
catch (SoftExpertException erro)
{
    // Erro retornado pela API SoftExpert
    Console.WriteLine(erro.Message);
}
catch (Exception erro)
{
    // Falha genérica (rede, configuração, etc.)
    Console.WriteLine(erro.Message);
}

Documentação das funções

Cada função pública possui um arquivo próprio com explicação, parâmetros, retorno e exemplo:

docs/README.md

Conjuntos de dados necessários no SoftExpert: docs/ConjuntosDeDados.md

Workflow (SoftExpertWorkflowApi)

Para as funções abaixo, considerar o instanciamento do objeto abaixo:

SoftExpertWorkflowApi wfAPI = new SoftExpertWorkflowApi(configs);
Função Diretório controlado Conjunto de dados Objetivo
newWorkflow Criar instância de processo
cancelWorkflow Cancelar instância
executeActivity Executar atividade
newAttachment Anexar arquivo no menu de anexos
ListAttachmentFromInstance ✔ ✔ Listar anexos da instância
GetFileFromOID ✔ ✔ Obter arquivo a partir do OID
editEntityRecord Editar campos do formulário
newChildEntityRecord Criar registro em grid
editChildEntityRecord Editar registro em grid
newTableRecord Criar registro de tabela (Form)
editTableRecord Editar registro de tabela (Form)
deleteTableRecord Excluir registro de tabela (Form)
addHistoryComment Adicionar comentário no histórico
unlinkActivityFromUser Desassociar atividade do usuário
reactivateWorkflow ✔ Reativar instância
returnWorkflow ✔ Retornar para uma atividade
finishWorkflow ✔ Encerrar instância
delegateWorkflow ✔ Delegar atividade
AlterUserStart Alterar usuário iniciador
GetWorflowStatus ✔ Consultar status da instância
GetCurrentActivities ✔ Listar atividades em andamento
GetActivitiesFromInstance ✔ Listar atividades da instância

Administração (SoftExpertAdminApi)

Para as funções abaixo, considerar o instanciamento do objeto abaixo:

SoftExpertAdminApi adAPI = new SoftExpertAdminApi(configs);
Função Objetivo
enableUser Habilitar usuário
disableUser Desabilitar usuário

Genérico (SoftExpertGenericApi)

Para as funções abaixo, considerar o instanciamento do objeto abaixo:

SoftExpertGenericApi genAPI = new SoftExpertGenericApi(configs);
Função Licença de gestão Objetivo
newTeam Criar nova equipe
addUserToTeam Adicionar usuário a uma equipe
removeUserFromTeam Remover usuário de uma equipe
setTeamPermissions ✔ Definir permissões de segurança da equipe

Conjunto de dados (SoftExpertDataSetApi)

Para as funções abaixo, considerar o instanciamento do objeto abaixo. As configs deve ter sido configurada a props url e token.

SoftExpertDataSetApi dsAPI = new SoftExpertDataSetApi(configs);
Função Objetivo
Query Consultar um conjunto de dados via REST

Observações

  • Funções iniciadas com letra minúscula (newWorkflow) espelham APIs originais do SoftExpert.
  • Funções iniciadas com letra maiúscula (AlterUserStart) possuem implementação própria e/ou usam endpoints/datasets do SoftExpert.
  • ✔ Diretório controlado: requer implementação de IFileDownload em configs.downloader.
  • ✔ Conjunto de dados: requer criação do conjunto de dados correspondente no SoftExpert — ver docs/ConjuntosDeDados.md.
  • ✔ Licença de gestão: requer licença de gestão e uma sessão de gestão disponível no SoftExpert.
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.4.12 117 10/29/2026
1.4.11 117 10/29/2026
1.4.10 120 10/21/2026
1.4.9 117 9/24/2026
1.4.8 135 9/15/2026
1.4.7 121 9/8/2026
1.4.6 162 9/8/2026
1.4.5 152 9/2/2026
1.4.4 131 8/27/2026
1.4.3 161 8/24/2026
1.4.2 146 8/24/2026
1.4.1 142 8/24/2026
1.4.0 140 8/20/2026
1.3.36 235 5/11/2026
1.3.35 162 4/22/2026
1.3.34 201 3/20/2026
1.3.33 162 3/20/2026
1.3.32 515 8/5/2025
1.3.29 388 8/5/2025
1.3.28 391 8/5/2025
Loading failed