Pular para o conteúdo principal

Começando

Comece enviando documentos para assinatura em poucos minutos.

Postman

Você pode fazer download da collection do postman para facilitar os testes clicando aqui.

Criando um aplicativo

Para acessar a API da plataforma e seus recursos, é necessário que faça login e entre na área para desenvolvedores e crie uma aplicação. Caso não tenha familiaridade com OAuth, esta aplicação é o que lhe permitirá gerar tokens de acesso para que possa fazer as chamadas de API a partir de sua conta com os acessos estabelecidos pelo seu plano contratado.

tela de lista de aplicações

tela de criação de aplicação

Depois da criação, anote seu client id e client secret, eles serão usados para que consiga gerar access tokens para chamadas na API.

tela da modal de client secret

Sobre os client secrets

Faça o armazenamento seguro do seu client secret gerado, pois ele será gerado somente no momento da criação da aplicação e não poderá ser acessado novamente.

Gerando um token de acesso

Com o aplicativo criado, podemos então gerar o access token que será usado para fazer as chamadas de API. Para isso, com seu client id e client secret em mãos, faça a chamada conforme:

POST https://apisx.assine.online/oauth/token
{
"grant_type": "client_credentials",
"client_id": "seu-client-id",
"client_secret": "seu-client-secret",
"scope": "*"
}

Se tudo estiver correto, você terá o seu access token pela resposta. Exemplo:

{
"token_type": "Bearer",
"expires_in": 259200,
"access_token": "seu-access-token"
}

Com isso, todas as requisições seguintes devem ter esse access token enviado em um header de Authorization. Exemplo:

curl -i -H 'Authorization: Bearer <seu-access-token>' -H 'Accept: application/json' -X GET https://apisx.assine.online/v1/envelopes

Com isso já é possível começar a criar envelopes e subir documentos para assinatura.