A API Sign.Plus capacita os desenvolvedores para integrarem perfeitamente assinaturas eletrônicas seguras e vinculativas em seus aplicativos e sites. Essa integração cria uma experiência de assinatura suave para os usuários dentro da sua plataforma.
Siga este guia para começar com a API Sign.Plus:
Criar uma conta e atualizar para um plano de API
Para começar a usar a API Sign.Plus, você precisará criar uma conta e atualizar para um plano API:
- Escolha o plano que se adeque às suas necessidades e crie uma conta.
Gere seu token de acesso pessoal
Após a atualização, você precisará criar um Token de Acesso Pessoal para interagir com a API Sign.Plus:
- Na seção da API, localize a opção de criar um novo Token de Acesso Pessoal.
- Choose the permission scopes for your token:
sign:all:read
: Grants access to read resources (GET
endpoints)sign:all:edit
: Allows editing of resources (POST
,PUT
,DELETE
endpoints)
Tip: You can select both scopes or just one, depending on your needs
-
Defina uma data de validade para seu token.
Tip: We recommend a 90-day expiration period.
-
Gere seu token e armazene-o com segurança. Você não será capaz de vê-lo novamente depois deste passo.
Nota: Configure lembretes de rotação de chaves de renovação para manter a rigorosa segurança de acesso à API.
Teste a sua conexão API
Assim que você tiver seu Token de Acesso Pessoal, é hora de garantir que tudo está funcionando corretamente. Você tem algumas opções para interagir com a nossa API:
-
cURL
Abra seu terminal e execute o seguinte comando:curl -I --location '<https://restapi.sign.plus/v2/envelopes>' \\
--header 'Content-Type: application/json' \\
--header 'Authorization: $PERSONAL_ACCESS_TOKEN' \\
--data '{}'Substituir $PERSONAL_ACCESS_TOKEN pelo token que você gerou anteriormente.
Se você receber um código de status200 OK
, parabéns! A sua conexão de API está funcionando corretamente.
-
Cartaz
-
Abrir Postman e criar uma nova solicitação.
-
Defina o tipo de solicitação para POST e digite a URL do ponto de extremidade da API
https://restapi.sign.plus/v2/envelopes
- Na aba Cabeçalhos, adicione um novo cabeçalho:
- Chave:
Autorização
- Valor:
Portador $PERSONAL_ACCESS_TOKEN
-
Envie o pedido e verifique se há uma resposta do status
200 OK
. Parabéns! Você está pronto para começar a usar a API Sign.Plus de eSignature em seus projetos.
-
Aqui estão alguns passos e recursos adicionais para ajudá-lo a aproveitar ao máximo a nossa API:
Documentação da API
For detailed information on API endpoints and advanced features, please refer to our comprehensive API documentation.
SDKs backends
We strongly recommend using our Backend SDKs (Install - Sign.Plus API ) to seamlessly integrate the Sign.Plus eSignature API within your backend. Oferecemos SDKs para os seguintes idiomas:
- Python
- TypeScript
- OK
- Java
- C#
- PHP
Usar esses SDKs pode simplificar significativamente o seu processo de integração e ajudá-lo a funcionar rapidamente.