Através deste guia, demonstraremos como alterar ou criar contatos através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de criar ou alterar contatos com apenas um endpoint.
Antes de iniciar sua integração:
Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.
Através deste endpoint, você poderá criar ou editar contatos utilizando um CPF como chave única de consulta.
Caso o CPF enviado na requisição ainda não esteja cadastrado, um novo contato associado a sua conta será criado. Caso o CPF já existam, atualizaremos os dados do contato com as informações enviadas na requisição.
Entenda, a seguir, como chamar nossa API REST para criar ou editar contatos:
Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familiarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.
Ambientes
Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Somente após o processo de testes e certificação você receberá credenciais de produção.
Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:
Ambiente de homologação: https://signhom.acesso.io;
Ambiente de produção: https://sign.acesso.io.
/cancel/Após gerar um token de acesso válido, faça uma requisição para o endpoint de gerenciamento de contatos da nossa API REST (POST/service/contact) enviando os parâmetros conforme o schema abaixo:
ContactName
string
Nome do assinante
ContactCPF
string
Número de cadastro de pessoa física do assinante
sem formatação, apenas os 11 números
Não é possível atualizar CPF de algum assinante existente. Sendo assim, caso seja fornecido um novo CPF haverá o registro de um novo assinante
ContactEmail
string or null <email>
E-mail da assinante
ContactPhone
string or null <tel>
Telefone do assinante com DDD
Sem formatação e contendo apenas 10 ou 11 números
ContactIdentifier
string or null
Campo livre, não único, para identificação do contato do lado do cliente
TenantID
string or null <uuid>
Identificador único da empresa
Units
Array of strings or null <uuid>
Identificador único da unidade/filial
Permissão para Visualizar Documentos
Para utilizar esta rota é necessário que o usuário tenha permissão de Adminstrar Contatos.
Abaixo um exemplo alterando o nome e o e-email do CPF 100.000.000-19 (Assumindo que o CPF já existe na base).
Se tudo der certo em sua requisição, você receberá como resposta um JSON contendo a confirmação da inclusão ou atualização do contato, conforme abaixo:
Conheça as funcionalidades disponíveis para o Gerenciamento de documentos.
Conheça as funcionalidades disponíveis para o Gerenciamento de envelopes.
Tendo problemas em nossa integração? Acesse nossa seção de FAQ e problemas comuns.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.