Pular para o conteúdo principal

Obter categorias

Sobre este guia​

Através deste guia, demonstraremos como obter todas as categorias e subcategorias disponíveis de um usuário através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todas as categorias disponíveis em seus documentos em uma resposta JSON.

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​

Como explicamos em nosso guia de conceitos básicos, Documentos (document) são a representação virtual de um documento que deve ser assinado (por um ou mais assinanates) e pode ser gerado a patir de um arquivo PDF ou de um modelo (Template).

Cada documento pode ser classificado com uma categorias e subcategoria. Essas categorias são uteis para classificar e identificar facilmente quais IDs correspondem a quais documentos.

Entenda, a seguir, como chamar nossa API Rest para obter suas categorias:

  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 GET para o endpoint /categories/​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de obtenção de categorias da nossa API REST (GET/service/categories).

    Abaixo um exemplo da requisição:

    curl -X 'GET' \
      'https://sign-core-dev.acesso.io/api/v1/service/categories/' \
      -H 'accept: application/json' \
      -H 'Authorization: Bearer {{ACCESS_TOKEN}}'

    Se tudo der certo em sua requisição, você receberá como respota um JSON contendo as categorias com seus documentIds.

    {
      "Success": true,
      "Message": "",
      "Data": {
        "Page": 5,
        "Count": 1,
        "DocumentCategories": [
          {
            "DocumentCategoryName": "Admissão",
            "UUID": "00000000-0000-0000-0000-000000000000",
            "DocumentSubcategories": [
              {
                "DocumentSubcategoryName": "Contrato",
                "DocumentCategoryUUID": "dad4bfa9-a993-492d-953e-d412d2d185f3",
                "UUID": "00000000-0000-0000-0000-000000000000"
              },
              {
                "DocumentSubcategoryName": "Exame médico",
                "DocumentCategoryUUID": "dad4bfa9-a993-492d-953e-d412d2d185f3",
                "UUID": "00000000-0000-0000-0000-000000000000"
              }
            ]
          }
        ]
      }
    }

Próximos passos​

Ficou com dúvidas?​

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