Integração SAP
Kit oficial para S/4HANA, ECC e SuccessFactors — iFlows para o SAP Integration Suite (CPI), cliente ABAP e cockpit Fiori.
Assine documentos gerados no SAP sem desenvolver integração do zero: o ForSign SAP Integration Kit é um pacote open source (Apache-2.0) pronto para o SAP Integration Suite (Cloud Integration/CPI), com cliente ABAP e app Fiori inclusos.
O que vem no kit
Criar operação (upload + criação em uma chamada), consultar status, baixar o documento assinado e receber webhooks com validação HMAC-SHA256.
ZCL_FORSIGN_CLIENT — 3 métodos para o ECC 7.40+/S/4HANA, instalável via abapGit; inclui o programa de demonstração ZFORSIGN_DEMO.
App SAPUI5 para acompanhar operações e baixar o PDF assinado sem sair do Launchpad.
Todos os iFlows validam o payload antes de chamar a API e devolvem erro canônico JSON com o HTTP status correto — nunca stacktrace.
Especificação OpenAPI 3.0 do contrato canônico e coleção Postman com encadeamento automático de IDs.
Suite de testes dos scripts, CI no GitHub Actions e releases com artefatos prontos e checksums.
Como funciona
Comece agora
Baixe o kit
Os iFlows prontos estão nas releases do repositório — um zip por iFlow, com checksums.
Importe e configure no Integration Suite
Design → Add → Integration Flow → Upload. Depois crie os Secure
Parameters (ForSign_ApiKey com a sua chave de API,
ForSign_WebhookSecret) e configure os parâmetros externalizados. Guia
completo no
setup guide.
Registre o webhook
Registre o evento DocumentReady apontando para o iFlow receptor —
é o gatilho correto para o download (dispara quando os PDFs finais estão
selados). Veja Webhooks.
Teste
Use a coleção Postman incluída no kit — ou rode ZFORSIGN_DEMO no seu
sistema ABAP (PDF local → operação → links de assinatura → status).
Regras do contrato canônico
O kit expõe um payload simplificado e traduz para o POST /api/v1/operation. O que você precisa saber:
externalIdé a sua chave SAP (nº do pedido, nº do colaborador...). Ela volta em todos os webhooks para correlação; combinada commergeIfExists: true, garante idempotência em retries.- Tipos visuais de assinatura (
Draw,Text,UserChoice) exigemsignatures[].positionscom coordenadas em % — o kit valida antes de chamar a API e devolve erro estruturado. - O
documentIdé injetado automaticamente: o SAP não precisa conhecer o id do upload — o kit preenche emsignatures,rubricseformFields. - Anexos e formulários funcionam normalmente —
attachments[]eformFields[]do assinante passam direto para a API (veja Criar operação).
Use o webhook DocumentReady (não CompletedOperation) como gatilho de
download — CompletedOperation dispara antes de o PDF final estar selado.
Cenários documentados
| Cenário | Disparo | Retorno |
|---|---|---|
| S/4HANA / ECC — contratos de compra/venda, aditivos, documentos de RH | ABAP outbound (ZCL_FORSIGN_CLIENT) ou Communication Arrangement | Webhook → ICF/OData → PDF no ArchiveLink/GOS |
| SuccessFactors — admissão digital (Onboarding), contratos de trabalho | Intelligent Services / Integration Center → CPI | Webhook → OData Attachment no perfil do colaborador |
Detalhes de payload e convenções por cenário no guia de cenários.
Veja também
Repositório do kit
iFlows, ABAP, Fiori, OpenAPI, testes e releases.
Criar operação
O endpoint que o kit encapsula — payload completo.
Webhooks
Eventos, HMAC e retries.
Fluxo de uma operação
O arco completo, do upload ao download.
Dúvidas ou precisa de ajuda com o cenário SAP? [email protected]