Skip to main content

Gerenciamento de contatos

Sobre este guia​

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.

O que você vai precisar​

Antes de iniciar sua integração:

  1. 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.
  2. 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.

Funcionamento básico​

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:

  1. Obtenha um token OAuth válido;​

    Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familizarizado 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. Sómente 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.

  2. Faça uma requisição POST para o endpoint /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

    {
    • "ContactName": "Margaria Clara",
    • "ContactCPF": "10000000019",
    • "ContactEmail": "test@test.com",
    • "ContactPhone": "1192345678",
    • "ContactIdentifier": "string",
    • "TenantID": "00000000-0000-0000-0000-000000000000",
    • "Units": [
      ]
    }
    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).


    curl -X 'POST' \
      'https://sign-core-uat.acesso.io/api/v1/service/contact' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {{ACCESS_TOKEN}}'
      -d ''{
      "ContactName": "Margaria Clara",
      "ContactCPF": "10000000019",
      "ContactEmail": "test@test.com",
      "ContactPhone": "1192345678",
      "ContactIdentifier": "test-123-test"
    }'

    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:

    Exemplo de inclusão de contato
    {
      "Success": true,
      "Message": "Contato inserido com sucesso"
    }
    Exemplo de atualização de contato
    {
      "Success": true,
      "Message": "Contato atualizado com sucesso"
    }
    API Reference

    Aprenda mais sobre este endpoint em nosso API Reference.

Próximos passos​

Ficou com dúvidas?​

Esperamos ter ajudado com este artigo. Não encontrou algo ou ainda precisa de ajuda?