Configurando a autenticação da API OData do SuccessFactors no Jitterbit App Builder
O SuccessFactors suporta o fluxo OAuth 2.0 SAML Bearer Assertion. Este fluxo fornece autorização restrita ao usuário, trocando asserções SAML por tokens de acesso conforme descrito na seguinte especificação:
https://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-23
Este documento aborda as seguintes tarefas:
- Registrar o App Builder como uma Aplicação Cliente OAuth2 do SuccessFactors
- Registrar o SuccessFactors como um provedor de segurança do App Builder.
- Registrar o servidor de fonte de dados do Serviço OData do SAP.
Requisitos
Para prosseguir, você precisará do seguinte:
- Uma conta SuccessFactors existente.
- Acesso de administrador à conta SuccessFactors.
- Acesso de administrador ao App Builder.
Registrar o App Builder como uma aplicação cliente OAuth2 do SuccessFactors
O App Builder precisará ser registrado no SuccessFactors como uma Aplicação Cliente OAuth2. Para registrar o App Builder como uma Aplicação Cliente OAuth2, você precisará das seguintes informações:
| Exemplo | Observações | |
|---|---|---|
| Nome da Aplicação | App Builder | O nome da aplicação é arbitrário. Se registrar múltiplas instâncias do App Builder como Aplicações Cliente OAuth2, atribua a cada uma um nome distintivo. |
| URL da Aplicação | https://example.com/Vinyl/ | Esta é a raiz web do App Builder. A URL deve incluir a barra à direita. |
| Nome Comum | example.com | Esta é a porção do nome do host da raiz web. |
Para registrar o App Builder como uma Aplicação Cliente OAuth2 do SuccessFactors:
- Faça login no SuccessFactors como administrador
- Navegue até o Admin Center
- Selecione Company Settings → Manage OAuth 2 Client Applications
- Clique no botão Register Client Application
- Forneça o Application Name e Application URL
- Clique no botão Generate X.509 Certificate
- Forneça o Common Name (CN)
- Clique no botão Generate
- Clique no botão Download para salvar o certificado
- Clique no botão Register
Após o registro, o SuccessFactors atribuirá uma API Key. A API Key, juntamente com o certificado, será necessária para concluir os procedimentos restantes.
Converter certificado
O SuccessFactors gera um certificado em formato PEM; o App Builder requer um certificado em formato PKCS#12 codificado em base64. Uma discussão completa sobre este tópico está fora do escopo deste documento. Porém, como exemplo, o utilitário de linha de comando OpenSSL pode ser usado para converter um certificado de PEM para PKCS#12:
openssl pkcs12 -in certificate.pem -export -out certificate.pfx
Observe que você será solicitado a fornecer uma senha. Registre a senha, pois ela será necessária posteriormente.
Para codificar o certificado em base64:
openssl base64 -in certificate.pfx -out certificate.txt -A
Para obter informações adicionais sobre certificados de Aplicação Cliente OAuth2 do SuccessFactors, consulte o seguinte documento:
http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf
Nota
No momento da redação, o SuccessFactors não gera um certificado compatível com OpenSSL. Para tornar o certificado compatível, abra o certificado em um editor de texto e faça as seguintes alterações:
Substitua ambas as ocorrências de "ENCRYPTED PRIVATE KEY" por "PRIVATE KEY".
Registrar SuccessFactors como provedor de
segurança do App Builder {: #register-successfactors-as-an-app-builder-security-provider }
Para registrar SuccessFactors como provedor de segurança do App Builder, você precisará das seguintes informações:
| Exemplo | Notas | |
|---|---|---|
| Chave de API | A Chave de API é atribuída pela SuccessFactors ao registrar a Aplicação Cliente OAuth2 (veja acima). | |
| Certificado de Assinatura | O certificado de assinatura deve ser um certificado PKCS#12 codificado em base64 contendo a chave privada. O certificado pode ser gerado manualmente ou durante o processo de registro da Aplicação Cliente OAuth2 da SuccessFactors (veja acima). | |
| Senha do Certificado de Assinatura | A senha do certificado de assinatura é atribuída ao gerar o certificado formatado PKCS#12. | |
| ID da Empresa | O identificador da empresa SuccessFactors. | |
| URL da API da Instância | https://api8.successfactors.com/ | URL da API SuccessFactors: "Suas URLs de ponto de acesso para acessar as APIs OData dependem do data center que hospeda sua instância SuccessFactors." Consulte http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf para obter informações adicionais. |
Nota
A URL não contém o caminho /odata/v2. O App Builder adicionará o caminho.
Para registrar SuccessFactors como provedor de segurança do App Builder:
- Faça login no App Builder como Administrador
- Navegue até a IDE
- Clique no botão Provedores de Segurança
- Clique no botão + Provedor de Segurança
-
Forneça o seguinte:
- Nome: Um nome único do provedor de segurança.
- Exemplo: SuccessFactors
- Tipo: SuccessFactors OData
-
Prioridade: Um inteiro único entre 10 e 100. Observe que esse valor deve ser único.
Exemplo: 40
-
Clique no botão Salvar
-
Defina as seguintes propriedades (No painel Propriedades, clique no botão + Propriedade → Selecione o Parâmetro → Forneça o Valor → Clique no ícone Salvar):
-
AuthenticationType: Saml
- CompanyID: ID da Empresa
- ApiKey: Chave de API
- InstanceApiUrl: URL da API da Instância
- SigningCertificate: Certificado de Assinatura
-
SigningCertificatePassword: Senha do Certificado de Assinatura
-
Clique no botão Editar no painel Provedores
- Marque a opção Ativado
- Clique no botão Salvar
Registre o servidor da fonte de dados do SAP OData
Para registrar o SuccessFactors como servidor de fonte de dados do App Builder, você precisará das seguintes informações:
| Exemplo | Observações | |
|---|---|---|
| Endpoint OData | https://api8.successfactors.com/odata/v2/ | URL da API SuccessFactors: "As URLs de endpoint para acessar as APIs OData dependem do data center que hospeda a sua instância do SuccessFactors." Consulte http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf para obter informações adicionais. |
| Nome do Provedor de Segurança | SuccessFactors | O nome do provedor de segurança fornecido acima. |
Nota
A partir de março de 2016, o Endpoint OData parece exigir uma barra à direita.
Para registrar o SuccessFactors como Servidor de Fonte de Dados do App Builder:
- Faça login no App Builder como administrador
- Navegue para o IDE
- Selecione o botão Servidores de Dados
- No painel Servidores de Dados, clique no botão + Servidor
-
Forneça o seguinte:
- Nome: Um nome de servidor único e lógico.
- Exemplo: SuccessFactors
- Tipo: SuccessFactors
-
URL:
{Endpoint OData}Exemplo: https://api8.successfactors.com/odata/v2 -
Exemplo:
https://api8.successfactors.com/odata/v2 - Provedor de Segurança:
{Nome do Provedor de Segurança}
-
Clique no botão Salvar
Depois que o servidor de fonte de dados for registrado, clique no botão Testar Conexão para garantir que tudo esteja configurado corretamente. Você pode ser solicitado a fazer login com o Okta neste momento.
Resolução de Problemas
Uma lista de respostas de erro OAuth 2.0 do SuccessFactors está disponível na seguinte página:
http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf
O apêndice "Mensagens de Erro Relacionadas ao OAuth 2.0" a seguir contém erros adicionais:
Consulte o seguinte para obter informações adicionais sobre resolução de problemas:
Security provider - successfactors OData
"O servidor não está disponível ou as informações de conexão estão incorretas." ao testar a conexão
Certifique-se de que a URL do servidor de fonte de dados termina com uma barra. Por exemplo:
https://api8.successfactors.com/odata/v2/
A partir de março de 2016, o SuccessFactors requer uma barra no final.
"Accessing OData API using Basic authentication or External OAuth on non-API servers is forbidden." ao testar a conexão
É possível que o endpoint da API tenha sido substituído por um novo endpoint. Por exemplo, os seguintes endpoints foram substituídos:
- Em novembro de 2015, o endpoint da API
https://salesdemo4.successfactors.com/foi substituído porhttps://apisalesdemo4.successfactors.com/. - Em março de 2016, o endpoint da API
https://hcm8preview.sapsf.com/foi substituído porhttps://api8preview.sapsf.com/.