Setup Inicial - Duplicatas Escriturais
Para iniciar sua integração com as APIs de Duplicatas Escriturais da Shipay é necessário ter um ambiente de integração cadastrado no Painel Shipay (ambiente de staging). Caso ainda não tenha esse cadastro, você pode conferir as etapas de criação aqui.
Passo a Passo:
1. Solicite que seu ambiente de integração seja configurado para duplicatas escrituais:
Envie um e-mail para integracao@shipay.com.br solicitando a configuração do seu ambiente de integração de duplicatas escriturais e indique quais das seguintes jornadas serão integradas ao seu sistema:
a. Sacado
b. Sacador
c. Financiador
2. Obter Certificado mTLS:
- Utilizamos criptografia
mTLSpara garantir a segurança da comunicação com as APIs de duplicatas escriturais.No ambiente de produção da Shipay, é necessário emitir um certificado para cada cliente cadastrado no Painel.
Para obtenção do seu certificado, o passo a passo abaixo deve ser seguido (bash/unix):
4.1. Comando para gerar o arquivo de chave privada:
openssl genrsa -out nome-da-sua-chave.key 2048
b. Comando para gerar o arquivo .csr (certificate signing request) usando a chave privada criada no passo anterior:
openssl req -new -key nome-da-sua-chave.key -out nome-do-seuCSR-chave.csr
Ao executar o comando acima, preencha as informações conforme este exemplo:
- Country Name: BR (sigla do seu país)
- State or Province name: SP (seu estado)
- Locality Name: São Paulo (ou sua cidade)
- Organization Name: (Nome da sua empresa)
- Organizational Unit Name: Staging (Para Produção, envie Production)
- Email: (Seu email)
- Commom Name: (Pressione enter, deixando em branco)
- Password & Company Name: (Pressione enter, deixando em branco)
4.2. Enviar o arquivo .csr para assinatura:
Envie o arquivo .csr para integracao@shipay.com.br informando se trata-se da emissão de um certificado novo ou de renovação de um certificado prestes a expirar.
O certificado será retornado pela Shipay em até 2 dias úteis.
Importante: O certificado retornado pela Shipay terá validade de 1 ano! Recomendamos fortemente que sejam implementados mecanismos de monitoramento da data de expiração com a finalidade de garantir a continuidade da operação com as APIs de cash-out da Shipay. Para renovar seu certificado, são necessários seguir os passos a partir do item 4.1.b do passo a passo anterior
3. Acesso ao Painel:
- Faça o login no Painel Shipay de Staging usando seus dados de acesso recebidos por e-mail.
Esqueceu sua senha ou o link de acesso expirou, clique em “Esqueceu a senha?” ao entrar no painel. Verifique sua caixa de SPAM/Promoções caso não tenha recebido nenhum e-mail.
4. Obtenção das Credenciais da API:
i. No menu, vá para Clientes (se você não visualizar essa opção, pule para o item iii)
ii. Selecione Acessar no cliente desejado.
iii. Na aba Lojas, clique no nome da sua loja.
iv. Copie Access Key, Secret Key e Client ID para autenticação na API.