Começar a utilizar Sign.Plus API

Sign.Plus API permite aos desenvolvedores integrar de forma simples assinaturas eletrónicas seguras e juridicamente vinculativas nas suas aplicações e sites. Esta integração cria uma experiência de assinatura fluida para os utilizadores dentro da sua plataforma.

Siga este guia para começar a utilizar Sign.Plus API:

Criar uma conta e atualizar para um plano de API

Para começar a utilizar Sign.Plus API, terá de criar uma conta e atualizar para um plano de API:

1. Visite https://www.sign.plus/api/pricing.

2. Escolha o plano que melhor se adequa às suas necessidades e crie uma conta.

Gerar o seu token de acesso pessoal

Após atualizar, terá de criar um Token de Acesso Pessoal para interagir com Sign.Plus API:

1. Na secção API, localize a opção para criar um novo Token de Acesso Pessoal.

2. Escolha os âmbitos de permissão para o seu token:
   sign:all:read: Concede acesso de leitura aos recursos (pontos finais GET)
   sign:all:edit: Permite a edição de recursos (pontos finais POST, PUT e DELETE)

   Dica: Pode selecionar ambos os âmbitos ou apenas um, dependendo das suas necessidades

3. Defina uma data de expiração para o seu token.

   Dica: Recomendamos um período de expiração de 90 dias.

4. Gere o seu token e guarde-o de forma segura. Não poderá voltar a visualizá-lo depois deste passo.
   

   Nota: Configure lembretes de renovação e rotação de chaves para manter uma segurança de acesso à API rigorosa.

Testar a Ligação à API

Depois de obter o seu Token de Acesso Pessoal, é altura de garantir que tudo está a funcionar corretamente. Tem algumas opções para interagir com a nossa API:

1. cURL
   Abra o 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 '{}'

   Substitua $PERSONAL_ACCESS_TOKEN pelo token que gerou anteriormente.

   Se receber um código de estado 200 OK, parabéns! A sua ligação à API está a funcionar corretamente.
   
2. Postman
   

   • Abra o Postman e crie um novo pedido.

   • Defina o tipo de pedido como POST e introduza o URL do ponto final da API

     https://restapi.sign.plus/v2/envelopes
   • No separador Cabeçalhos, adicione um novo cabeçalho:
   • Chave: Authorization
   • Valor: Bearer $PERSONAL_ACCESS_TOKEN

   • Envie o pedido e verifique se recebe uma resposta com o código de estado 200 OK. Parabéns! Está agora pronto para começar a utilizar a API de assinatura eletrónica Sign.Plus nos seus projetos.

Seguem-se alguns próximos passos e recursos adicionais para o ajudar a tirar o máximo proveito da nossa API:

Documentação da API

Para informações detalhadas sobre os pontos finais da API e funcionalidades avançadas, consulte a nossa documentação abrangente da API.

SDKs de backend

Recomendamos vivamente a utilização dos nossos SDKs de backend (Install - Sign.Plus API ) para integrar de forma perfeita a assinatura eletrónica Sign.Plus API no seu backend. Oferecemos SDKs para as seguintes linguagens:

• Python
• TypeScript
• Go
• Java
• C#
• PHP
   

A utilização destes SDKs pode simplificar significativamente o processo de integração e ajudar a começar a trabalhar rapidamente.