goTokens
  • 🚀Comunidade goBlockchain
  • goTokens
    • 🤯Sobre a goTokens
    • 😎Casos de uso com a goTokens?
      • 👊Mão na massa!
        • 🎟️Caso 01 - Cartelinha de selos de Fidelidade
          • 💡Outras ideias...
    • 🌐Módulos goTokens
    • 😎Como começar - Usuário
      • Validação de Benefício
      • Resgate de colecionáveis
    • 🤓 Como começar - Admin
      • Customizando Whitelabel Web
      • Visão Geral
      • Dashboard
      • Criar uma comunidade
      • Criar coleção de Venda
      • Criar coleção de Airdrop
      • Criar coleção de POAP
      • Criar coleção de Membership
      • Moedas de Utilidade
      • Membership
      • Criar Colecionável de (Venda)
      • Criar NFT (POAP ou Airdrop)
      • Ativar uma coleção ou colecionável
      • Editar Whitelabel
      • Token Gating
      • Configurar Mercado Pago
      • Como visualizar meu saldo
      • Criar benefício
      • Criando um desafio
      • Vouchers de resgate
      • Validação de Benefício
      • Transferir NFT para Metamask
      • Integração Sympla
    • ⚙️API Fidelidade
      • Autenticação
      • Autorização
      • Usuário
      • Empresa
      • Comunidade
      • Coleções
      • Token
      • Benefícios
      • Vouchers
      • Transações
      • Marketplace
      • White Label
      • Token Gating
    • ⚙️API Garantias
      • Autenticação
      • Garantias
    • 📖FAQ
    • 🔥Suporte
  • 💰Modelo comercial
  • 🗒️Changelog
  • Aprender
    • ⛓️Artigos goBlockchain
  • Legal
    • 📔Termos e condições
    • 🔐Política de privacidade
  • Contatos
    • Instagram
    • Meetup
    • Youtube
    • Github
    • Linkedin
    • Medium
    • Email
Powered by GitBook
On this page
  • Resumo
  • Objeto Benefits
  • Endpoints
  • Benefícios
  • (JWT) Lista os benefícios que o usuário logado tem direito
  • (JWT) Lista os informações de um dos benefícios que o usuário logado tem direito
  • Exibe benefícios de um token público
  • Gestão de Benefícios
  • (JWT) Lista os benefícios que o usuário tem acesso de edição
  • (JWT) Cria um benefício e seus vouchers
  • (JWT) Lista as informações de um determinado benefício para um administrador
  • (JWT) Atualiza as informações de um benefício
  • (JWT) Desativa um benefício

Was this helpful?

  1. goTokens
  2. API Fidelidade

Benefícios

Utilidades associadas aos tokens para engajamento de comunidade

Resumo

Se tratando de um programa de loyalties, é imprescindível que a API seja flexível o suficiente para garantir que a comunidade terá interesse em se manter engajada com benefícios exclusivos de sua participação no sistema.

Os benefícios são relacionados diretamente às NFTs, criando, assim, utilidades exclusivas para elas.

Caso o programa utilize "moedas", elas precisam ser trocadas por uma NFT para que o dono conquiste o benefício.

Os benefícios poderão ser digitais ou físicos, podendo expirar ou não.

Exemplos:

  • Físico - Acesso a evento de música

  • Físico - Voucher de desconto no ecommerce

  • Digital - Acesso ao grupo do Discord

Um benefício físico ou digital poderá ser associado à vouchers únicos que são apresentados quando um proprietário da NFT desejar. Esses vouchers são temporários, reduzindo riscos de segurança.

Cenário:

  • João possui uma NFT que lhe dá direito para assistir um show de música. Ao chegar na portaria, ele solicita a geração de um QRCode que deverá ser escaneado enquanto estiver válido. Caso o tempo expire, ele precisará solicitar um novo QRCode.

Como as NFTs podem ser negociadas no mercado secundário, a API de benefícios permite que que eles sejam associados ao metadata das NFTs, para que compradores possam visualizá-los na Opensea, por exemplo.

Objeto Benefits

Exemplo de Objeto de Benefício
{
  "id": "8798wdefs",
  "collectionId": "8th97sh19f3",
  "communityId": "gdr153ht789",
  "companyId": "yliki156sro",
  "name": "Benefit 1",
  "description": "Benefit 1 description",
  "externalUrl": "https://external-url.com",
  "type": "digital",
  "expirationDate": "2022-12-31 23:59:59",
  "tags": ["ambiental", "arte", "empreeendedorismo"],
  "hasVouchers": true,
  "elegibleTokens": [
    {
      "tokenId": "ijoaedwij",
      "voucherId": "45a1dw36"
    },
    {
      "tokenId": "879esf465",
      "voucherId": "0grte8789r",
    },
    {
      "tokenId":"213e6854f",
      "voucherId": "1e3wfa58ad8",
    },
    {
      "tokenId":"1c5e6799aw",
      "voucherId": "798fdsqwew87",
    }
  ]
}

Endpoints

Benefícios

  • GET /v1/benefits

  • GET /v1/benefits/:benefitId

  • GET /v1/benefits/token/:tokenId

Gestão de Benefícios

  • GET /v1/benefits/manage

  • POST /v1/benefits/manage

  • GET /v1/benefits/:benefitId/manage

  • PATCH /v1/benefits/:benefitId/manage

  • DELETE /v1/benefits/:benefitId/manage

Benefícios

(JWT) Lista os benefícios que o usuário logado tem direito

GET https://goblockchain.io/gotokens-api/v1/benefits

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator, member

Query Parameters

Name
Type
Description

name

String

Nome do Benefício

id

String

ID do Benefício

limit

String

Limite de resultados na busca

offset

String

Quantidade de resultados para avançar da busca

type

String

Tipo de resgate do Benefício

tags

Array

Tags do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

{
  "benefits": [
    {
      "id": "8798wdefs",
      "communityId": "gdr153ht789",
      "companyId": "yliki156sro",
      "collectionId": "789efe178d,
      "name": "Benefit 1 from Token A",
      "description": "Benefit 1 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",
      "tags": ["ambiental", "arte", "empreeendedorismo"],
      "expirationDate": "2022-12-31 23:59:59",
      "relatedVoucherId": "78r9sersd5",
      "relatedTokenId": "weda845dwa"
    },
    {
      "id": "8798wdefs",
      "companyId": "yliki156sro",
      "communityId": "gdr153ht789",
      "collectionId": "grd874r187ws,
      "name": "Benefit 1 from Token B",
      "description": "Benefit 1 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",
      "tags": ["ambiental", "arte", "empreeendedorismo"],
      "expirationDate": null,
      "relatedVoucherId": null,
      "relatedTokenId": "weda845dwa"
    },
    {
      "id": "8798wdefs",
      "companyId": "yliki156sro",
      "communityId": "gdr153ht789",
      "collectionId": "grd874r187ws,
      "name": "Benefit 2 from Token B",
      "description": "Benefit 2 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",
      "tags": ["ambiental", "arte", "empreeendedorismo"],
      "expirationDate": "2022-12-31 23:59:59",
      "relatedVoucherId": "rtg897drg15",
      "relatedTokenId": "4gre68refs1"
    },
  ]
}
    
  • benefits - Array of Objects

    Armazena as informações de cada benefício que o usuário logado tem direito.

    • id - String

      Identificador próprio do benefício.

    • companyId - String

      Identificador próprio da empresa gestora da comunidade.

    • communityId - String

      Identificador próprio da comunidade gestora da coleção.

    • collectionId - String

      Identificador próprio da coleção do token com aquele benefício.

    • name - String

      Nome do benefício.

    • description - String

      Descrição do benefício, podendo conter instruções de seu resgate.

    • externalUrl - String

      Link para redirecionamento externo caso o benefício exija alguma ação externa.

    • type - String

      Tipo de resgate do benefício. Pode ser digital ou physical.

    • expirationDate - DateTime

      Data e hora de validade do benefício, quando necessário.

    • relatedVoucherId - String

      Identificador próprio do voucher relacionado àquele benefício. Pode ser null caso o benefício não dê direito à um voucher.

    • relatedTokenId - String

      Identificador próprio do token que dá direito àquele benefício.

    • tags - Array

      Conjunto de tags do benefício.

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(JWT) Lista os informações de um dos benefícios que o usuário logado tem direito

GET https://goblockchain.io/gotokens-api/v1/benefits/:benefitId

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator, member

Path Parameters

Name
Type
Description

id

String

ID do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

{
  "id": "8798wdefs",
  "communityId": "gdr153ht789",
  "companyId": "yliki156sro",
  "collectionId": "789efe178d,
  "name": "Benefit 1 from Token A",
  "description": "Benefit 1 description",
  "externalUrl": "https://external-url.com",
  "type": "digital",
  "tags": ["ambiental", "arte", "empreeendedorismo"],
  "expirationDate": "2022-12-31 23:59:59",
  "relatedVoucherId": "78an9gr16wa",
  "relatedTokenId": "weda845dwa"
}
  • id - String

    Identificador próprio do benefício.

  • companyId - String

    Identificador próprio da empresa gestora da comunidade.

  • communityId - String

    Identificador próprio da comunidade gestora da coleção.

  • collectionId - String

    Identificador próprio da coleção do token com aquele benefício.

  • name - String

    Nome do benefício.

  • description - String

    Descrição do benefício, podendo conter instruções de seu resgate.

  • externalUrl - String

    Link para redirecionamento externo caso o benefício exija alguma ação externa.

  • type - String

    Tipo de resgate do benefício. Pode ser digital ou physical.

  • expirationDate - DateTime

    Data e hora de validade do benefício, quando necessário.

  • relatedVoucherId - String

    Identificador próprio do voucher relacionado àquele benefício.

  • relatedTokenId - String

    Identificador próprio do token que dá direito àquele benefício.

  • tags - Array

    Conjunto de tags do benefício

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

Exibe benefícios de um token público

GET https://goblockchain.io/gotokens-api/v1/benefits/token/:tokenId

Nível de permissionamento necessário: qualquer

Path Parameters

Name
Type
Description

tokenId*

String

ID do token

{
  "benefits": [
    {
      "id": "8798wdefs",
      "name": "Benefit 1 from Token A",
      "description": "Benefit 1 description",
      "tags": ["ambiental", "arte", "empreeendedorismo"],
    },
    {
      "id": "798shgrtd2",
      "name": "Benefit 2 from Token A",
      "description": "Benefit 2 description",
      "tags": ["ambiental", "arte", "empreeendedorismo"],
    }
  ]
}
  • benefits - Object

    Lista de benefícios do token, se houver.

    • id - String

      Identificador único do benefício no banco de dados.

    • name - String

      Nome do benefício.

    • description - String

      Descrição do benefício.

    • tags - Array

      Conjunto de tags do benefício.

Gestão de Benefícios

(JWT) Lista os benefícios que o usuário tem acesso de edição

GET https://goblockchain.io/gotokens-api/v1/benefits/manage

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator

Query Parameters

Name
Type
Description

name

String

Nome do Benefício

id

String

ID do Benefício

limit

String

Limite de resultados na busca

offset

String

Quantidade de resultados para avançar da busca

type

String

Tipo de resgate do Benefício

tags

Array

Tags do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

{
  "benefits": [
    {
      "id": "8798wdefs",
      "communityId": "gdr153ht789",
      "companyId": "yliki156sro",
      "collectionId": "789efe178d,
      "name": "Benefit 1 from Token A",
      "description": "Benefit 1 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",      
      "expirationDate": "2022-12-31 23:59:59",
      "hasVouchers": true,
      "elegibleTokens": [
        {
          "tokenId": "ijoaedwij",
          "voucherId": "45a1dw36"
        },
        {
          "tokenId": "879esf465",
          "voucherId": "0grte8789r",
        },
        {
          "tokenId":"213e6854f",
          "voucherId": "1e3wfa58ad8",
        },
        {
          "tokenId":"1c5e6799aw",
          "voucherId": "798fdsqwew87",
        }
      ]
    },
    {
      "id": "8798wdefs",
      "companyId": "yliki156sro",
      "communityId": "gdr153ht789",
      "collectionId": "grd874r187ws,
      "name": "Benefit 1 from Token B",
      "description": "Benefit 1 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",
      "expirationDate": null,
      "hasVouchers": false,
      "elegibleTokens": [
        {
          "tokenId": "ijoaedwij",
          "voucherId": null
        },
        {
          "tokenId": "879esf465",
          "voucherId": null,
        },
        {
          "tokenId":"213e6854f",
          "voucherId": null,
        },
        {
          "tokenId":"1c5e6799aw",
          "voucherId": null,
        }
      ]
    },
    {
      "id": "8798wdefs",
      "companyId": "yliki156sro",
      "communityId": "gdr153ht789",
      "collectionId": "grd874r187ws,
      "name": "Benefit 2 from Token B",
      "description": "Benefit 2 description",
      "externalUrl": "https://external-url.com",
      "type": "digital",
      "expirationDate": "2022-12-31 23:59:59",
      "hasVouchers": true,
      "elegibleTokens": [
        {
          "tokenId": "ijoaedwij",
          "voucherId": "45a1dw36"
        },
        {
          "tokenId": "879esf465",
          "voucherId": "0grte8789r",
        },
        {
          "tokenId":"213e6854f",
          "voucherId": "1e3wfa58ad8",
        },
        {
          "tokenId":"1c5e6799aw",
          "voucherId": "798fdsqwew87",
        }
      ]
    },
  ]
}
    
  • benefits - Array of Objects

    Armazena as informações de cada benefício que o usuário logado tem direito.

    • id - String

      Identificador próprio do benefício.

    • companyId - String

      Identificador próprio da empresa gestora da comunidade.

    • communityId - String

      Identificador próprio da comunidade gestora da coleção.

    • collectionId - String

      Identificador próprio da coleção do token com aquele benefício.

    • name - String

      Nome do benefício.

    • description - String

      Descrição do benefício, podendo conter instruções de seu resgate.

    • externalUrl - String

      Link para redirecionamento externo caso o benefício exija alguma ação externa.

    • type - String

      Tipo de resgate do benefício. Pode ser digital ou physical.

    • expirationDate - DateTime

      Data e hora de validade do benefício, quando necessário.

    • tags - Array

      Conjunto de tags do benefício

    • hasVouchers - Boolean

      Indica se determinado benefício deve possuir vouchers atrelados aos tokens. Caso true, a API atribui os códigos passados na requisição. Caso não sejam passados códigos, ela gerará códigos aleatórios de 8 caracteres distintos para cada token associado. Caso false, nenhum tratamento adicional é feito e os campos voucherId dentro de elegibleTokens são preenchidos como null.

    • elegibleTokens- Array of Objects

      Armazena os dados dos identificadores de tokens e vouchers relacionados àquele benefício.

      • tokenId - String

        Identificador próprio do token que dá direito àquele benefício.

      • voucherId - String

        Identificador próprio relativos ao voucher relacionados ao benefício. Pode ser null se o benefício não der direito à um voucher.

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(JWT) Cria um benefício e seus vouchers

POST https://goblockchain.io/gotokens-api/v1/benefits/manage

Essa rota permite a criação de um benefício e a aplicação dele à diversos tokens, assim como a criação sequencial de cada um dos vouchers passados como parâmetro em voucherCodes, já retornando na resposta o objeto final com os id dos vouchers.

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator

Headers

Name
Type
Description

authorization*

Bearer

JWT

Request Body

Name
Type
Description

name*

String

Nome do Benefício

type*

String

Tipo de resgate do Benefício. Valores possíveis: ['benefit', 'airdrop']

description*

String

Descrição do Benefício

externalUrl

String

Link para redirecionamento externo do benefício

expirationDate

DateTime

Data limite de resgate do código ou validade do benefício

elegibleTokens*

[Objects]

Lista de IDs de Tokens e códigos de Vouchers relacionados ao benefício

hasVouchers

Boolean

Indicativo de atrelar ou não vouchers aos tokens

companyId*

String

ID da Empresa

communityId*

String

ID da Comunidade

collectionId*

String

ID da Coleção

tags

Array

Tags do Benefício

rewardType*

String

O benefício em si é digital ou físico?

Valores possíveis: ['digital', 'physical']

status

String

Status de atividade do benefício. Por padrão é 'active'

Valores possíveis: ['active', 'disabled']

{
  "id": "8798wdefs",
  "companyId": "yliki156sro",
  "communityId": "gdr153ht789",
  "collectionId": "grd874r187ws",
  "name": "Benefit 2 from Token B",
  "description": "Benefit 2 description",
  "externalUrl": "https://external-url.com",
  "type": "benefit",
  "rewardType": "digital",
  "tags": ["ambiental", "arte", "empreeendedorismo"],
  "expirationDate": "2022-12-31 23:59:59",
  "hasVouchers": true,
  "elegibleTokens": [
    {
      "tokenId": "ijoaedwij",
      "voucherId": "45a1dw36"
    },
    {
      "tokenId": "879esf465",
      "voucherId": "0grte8789r",
    },
    {
      "tokenId":"213e6854f",
      "voucherId": "1e3wfa58ad8",
    },
    {
      "tokenId":"1c5e6799aw",
      "voucherId": "798fdsqwew87",
    }
  ]
}
  • id - String

    Identificador próprio do benefício.

  • companyId - String

    Identificador próprio da empresa gestora da comunidade.

  • communityId - String

    Identificador próprio da comunidade gestora da coleção.

  • collectionId - String

    Identificador próprio da coleção do token com aquele benefício.

  • name - String

    Nome do benefício.

  • description - String

    Descrição do benefício, podendo conter instruções de seu resgate.

  • externalUrl - String

    Link para redirecionamento externo caso o benefício exija alguma ação externa.

  • type - String

    Tipo de resgate do benefício. Pode ser benefit ou airdrop.

  • rewardType - String

    Tipo do benefício em si. Pode ser digital ou physical.

  • status- String

    Status de atividade do benefício. Pode ser active ou disabled.

  • tags - Array

    Conjunto de tags do benefício.

  • expirationDate - DateTime

    Data e hora de validade do benefício, quando necessário.

  • hasVouchers - Boolean

    Indica se determinado benefício deve possuir vouchers atrelados aos tokens. Caso true, a API atribui os códigos passados na requisição. Caso não sejam passados códigos, ela gerará códigos aleatórios de 8 caracteres distintos para cada token associado. Caso false, nenhum tratamento adicional é feito e os campos voucherId dentro de elegibleTokens são preenchidos como null.

  • elegibleTokens- Array of Objects

    Armazena os dados dos identificadores de tokens e vouchers relacionados àquele benefício.

    • tokenId - String

      Identificador próprio do token que dá direito àquele benefício.

    • voucherId - String

      Identificador próprio relativos ao voucher relacionados ao benefício. Pode ser null se o benefício não der direito à um voucher.

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(JWT) Lista as informações de um determinado benefício para um administrador

GET https://goblockchain.io/gotokens-api/v1/benefits/:benefitId/manage

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator

Path Parameters

Name
Type
Description

benefitId

String

ID do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

{
  "id": "8798wdefs",
  "communityId": "gdr153ht789",
  "companyId": "yliki156sro",
  "collectionId": "789efe178d,
  "name": "Benefit 1 from Token A",
  "description": "Benefit 1 description",
  "externalUrl": "https://external-url.com",
  "type": "digital",
  "tags": ["ambiental", "arte", "empreeendedorismo"],
  "expirationDate": "2022-12-31 23:59:59",
  "hasVouchers": true,
  "elegibleTokens": [
    {
      "tokenId": "ijoaedwij",
      "voucherId": "45a1dw36"
    },
    {
      "tokenId": "879esf465",
      "voucherId": "0grte8789r",
    },
    {
      "tokenId":"213e6854f",
      "voucherId": "1e3wfa58ad8",
    },
    {
      "tokenId":"1c5e6799aw",
      "voucherId": "798fdsqwew87",
    }
  ]
}
    
  • benefits - Array of Objects

    Armazena as informações de cada benefício que o usuário logado tem direito.

    • id - String

      Identificador próprio do benefício.

    • companyId - String

      Identificador próprio da empresa gestora da comunidade.

    • communityId - String

      Identificador próprio da comunidade gestora da coleção.

    • collectionId - String

      Identificador próprio da coleção do token com aquele benefício.

    • name - String

      Nome do benefício.

    • description - String

      Descrição do benefício, podendo conter instruções de seu resgate.

    • externalUrl - String

      Link para redirecionamento externo caso o benefício exija alguma ação externa.

    • type - String

      Tipo de resgate do benefício. Pode ser digital ou physical.

    • tags - Array

      Conjunto de tags do benefício.

    • expirationDate - DateTime

      Data e hora de validade do benefício, quando necessário.

    • hasVouchers - Boolean

      Indica se determinado benefício deve possuir vouchers atrelados aos tokens. Caso true, a API atribui os códigos passados na requisição. Caso não sejam passados códigos, ela gerará códigos aleatórios de 8 caracteres distintos para cada token associado. Caso false, nenhum tratamento adicional é feito e os campos voucherId dentro de elegibleTokens são preenchidos como null.

    • elegibleTokens- Array of Objects

      Armazena os dados dos identificadores de tokens e vouchers relacionados àquele benefício.

      • tokenId - String

        Identificador próprio do token que dá direito àquele benefício.

      • voucherId - String

        Identificador próprio relativos ao voucher relacionados ao benefício. Pode ser null se o benefício não der direito à um voucher.

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(JWT) Atualiza as informações de um benefício

PATCH https://goblockchain.io/gotokens-api/v1/benefits/:benefitId/manage

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator

Path Parameters

Name
Type
Description

benefitId

String

ID do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

Request Body

Name
Type
Description

name

String

Nome do Benefício

type

String

Tipo de resgate do Benefício

description

String

Descrição do Benefício

externalUrl

String

Link para redirecionamento externo do benefício

expirationDate

DateTime

Data limite de resgate do código ou validade do benefício

elegibleTokens

[Objects]

Lista de IDs de Tokens e de Vouchers relacionados ao benefício

hasVouchers

Boolean

Indicativo de atrelar ou não vouchers aos tokens

tags

Array

Tags do Benefício

{
  "id": "8798wdefs",
  "companyId": "yliki156sro",
  "communityId": "gdr153ht789",
  "collectionId": "grd874r187ws,
  "name": "Benefit 2 from Token B",
  "description": "Benefit 2 description",
  "externalUrl": "https://external-url.com",
  "type": "digital",
  "tags": ["ambiental", "arte", "empreeendedorismo"],
  "expirationDate": "2022-12-31 23:59:59",
  "hasVouchers": true,
  "elegibleTokens": [
    {
      "tokenId": "ijoaedwij",
      "voucherId": "45a1dw36"
    },
    {
      "tokenId": "879esf465",
      "voucherId": "0grte8789r",
    },
    {
      "tokenId":"213e6854f",
      "voucherId": "1e3wfa58ad8",
    },
    {
      "tokenId":"1c5e6799aw",
      "voucherId": "798fdsqwew87",
    }
  ]
}
  • id - String

    Identificador próprio do benefício.

  • companyId - String

    Identificador próprio da empresa gestora da comunidade.

  • communityId - String

    Identificador próprio da comunidade gestora da coleção.

  • collectionId - String

    Identificador próprio da coleção do token com aquele benefício.

  • name - String

    Nome do benefício.

  • description - String

    Descrição do benefício, podendo conter instruções de seu resgate.

  • externalUrl - String

    Link para redirecionamento externo caso o benefício exija alguma ação externa.

  • type - String

    Tipo de resgate do benefício. Pode ser digital ou physical.

  • tags - Array

    Conjunto de tags do benefício.

  • expirationDate - DateTime

    Data e hora de validade do benefício, quando necessário.

  • hasVouchers - Boolean

    Indica se determinado benefício deve possuir vouchers atrelados aos tokens. Caso true, a API atribui os códigos passados na requisição. Caso não sejam passados códigos, ela gerará códigos aleatórios de 8 caracteres distintos para cada token associado. Caso false, nenhum tratamento adicional é feito e os campos voucherId dentro de elegibleTokens são preenchidos como null.

  • elegibleTokens- Array of Objects

    Armazena os dados dos identificadores de tokens e vouchers relacionados àquele benefício.

    • tokenId - String

      Identificador próprio do token que dá direito àquele benefício.

    • voucherId - String

      Identificador próprio relativos ao voucher relacionados ao benefício. Pode ser null se o benefício não der direito à um voucher.

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

(JWT) Desativa um benefício

DELETE https://goblockchain.io/gotokens-api/v1/benefits/:benefitId/manage

Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator

Path Parameters

Name
Type
Description

id

String

ID do Benefício

Headers

Name
Type
Description

authorization*

Bearer

JWT

Código
Descrição

1

Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.

Código
Descrição

10

Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.

PreviousTokenNextVouchers

Last updated 1 year ago

Was this helpful?

⚙️