Token Gating
Controle de acesso baseado em tokens
Resumo
SoluĆ§Ć£o avanƧada permitindo uma conexĆ£o profunda com comunidades web3. Utilizando nossa API, empresas podem definir condiƧƵes baseadas em tokens ERC20 e NFTs.
Essa API Ć© altamente flexĆvel e poderosa, permitindo que vocĆŖ, como empresa, configure condiƧƵes complexas para controlar o acesso.
Utilizando operadores lĆ³gicos como AND (&) e OR (|), vocĆŖ pode criar regras de acesso multifacetadas. Por exemplo, vocĆŖ pode definir uma condiĆ§Ć£o que diz: "Se um membro da comunidade X possuir TokenA E TokenB, ele terĆ” acesso", ou "Se um membro da comunidade Y possuir TokenC OU TokenD, ele terĆ” acesso".
Desta forma, vocĆŖ pode usar a API para configurar um sistema de token gated personalizado que atenda Ć s suas necessidades especĆficas e ajude a fomentar o envolvimento da comunidade.
CriaĆ§Ć£o do token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate
CriaĆ§Ć£o do token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate
Esse endpoint cria um token gate e define o benefĆcio pode ser aplicado a esse acesso. Desde um simples acesso ou uma porcentagem de desconto.
Request Body
name*
String
Um nome que te lembre a que token gate se refire
discountPercentage
NĆŗmero
Porcentagem de desconto caso o pagamento seja realizado direto pela goTokens. O nĆŗmero inserido serĆ” em decimais, ou seja, para dar 10% de desconto, o valor inserido serĆ” 1000. (Equivalente a 10,00%) Caso nĆ£o deseje dar desconto, apague este campo
givesWhitelistAccess*
Booleano
Se queremos dar acesso ao usuĆ”rio esse parĆ¢metro deve ser "true"
maxUsageLimit
NĆŗmero
Se definido, serƔ a quantidade de acessos que um usuƔrio pode passar pelo token gate
Cadastro dos tokens que darĆ£o acesso ao token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/condition
Request Body
name*
String
Um nome que te lembre a que tokens se refire
contractAddress*
String
EndereƧo do contrato dos tokens na blockchain
individualTokenIds
Array
Se deseja explicitar os token que sĆ£o vĆ”lidos para o token gate, passe nesse array de strings.
Se esse valor nĆ£o for passado, qualquer token do contrato serĆ” aceito.
conditionalOperator*
String
O usuƔrio precisa cumprir com os requisitos apenas para 1 token ou para todos?
Para um, colocar: "or"
Para todos, colocar: "and"
countType*
String
Como a quantidade de tokens de um usuƔrio Ʃ contada.
Em outras palavras, o "amount" Ć© aplicado a 1 token ou ao conjunto de tokens?
Exemplo: Se o usuƔrio precisa ter 1 de cada token a contagem Ʃ individual. Caso precise ter 1 token ao todo, a contagem Ʃ a soma de todos os tokens.
Valores possĆveis "individual" ou "sum"
amount*
NĆŗmero
Quantidade necessƔria para o acesso ao token gate
network*
String
Rede blockchain do token. Valores possĆveis: "ethereum_mainnet", "polygon_mainnet", "gnosis_mainnet",
"ethereum_goerli",
"polygon_mumbai",
"gnosis_testnet",
AssociaĆ§Ć£o de condiĆ§Ć£o com token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/condition/{id}/add/token-gate
Request Body
name*
String
NVtVtd7wGfZs
discountPercentage
NĆŗmero
CsI14yanypav
givesWhitelistAccess*
Booleano
VFHNbLUEMw4v
maxUsageLimit
NĆŗmero
SyFnUrxEsz01
Cadastro dos tokens que darĆ£o acesso ao token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/condition
Request Body
name*
String
wuZVBBEBY8mW
contractAddress*
String
175t5a12m78e
individualTokenIds
Array
rDzojMB012cS
conditionalOperator*
String
GqoPFn0HCf3G
countType*
String
NOlbiUZX9voi
amount*
NĆŗmero
GvAeotH6mmtE
network*
String
DjG3laxWZ79R
AssociaĆ§Ć£o de condiĆ§Ć£o com token gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/condition/{id}/add/token-gate
Essa rota associa um token gate com as condiƧƵes necessƔrias para acessar o mesmo
Path Parameters
*
String
id do grupo de tokens cadastrado (condiĆ§Ć£o) no passo anterior
Request Body
benefitIds*
Array
Array de strings contendo o id dos token gates que queremos associar com o grupo de tokens cadastrado (condiĆ§Ć£o)
VerificaĆ§Ć£o do Token Gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/check/manage
Path Parameters
*
String
Fb0rZS5tVcHT
Request Body
benefitIds*
Array
6bpH3yYOJF1H
VerificaĆ§Ć£o do Token Gating
POST https://hml-mywayend.gotokens.io/api/v1/token-gate/check/manage
Verifica se um usuĆ”rio pode ou nĆ£o acessar um conteĆŗdo protegido por token gate
Request Body
userWallets*
Array
Lista de wallets de um usuƔrio, caso o mesmo possua mais de uma carteira
benefitIds*
Array
Lista de ids de benefĆcios que vocĆŖ quer ver se o usuĆ”rio tem direito
Request Body
userWallets*
Array
fnpLRsh8z3MU
benefitIds*
Array
Xw5dq3YVL7ej
Last updated
Was this helpful?