Ana içeriğe geç

Token Modeli

Token modeli, token bilgilerini temsil eden ana veri yapısıdır. Bu sayfa, token modelinin tüm alanlarını ve yapısını detaylı olarak açıklamaktadır.

TokenResponse

Token yanıt modeli, API yanıtlarında kullanılan ana token veri yapısıdır.

Alanlar

AlanTipAçıklama
idstringToken'ın benzersiz kimliği (UUID)
node_idstringToken'ın bağlı olduğu node'un kimliği
nodeNodeResponseNode bilgileri (opsiyonel, detaylı yanıtlarda dahil edilir)
distributor_idstringToken'ın bağlı olduğu distributor'ın kimliği
currency_token_idstringÖdeme için kullanılan currency token'ın kimliği
currency_tokenCurrencyTokenCurrency token bilgileri (opsiyonel)
chain_idintBlockchain ağ kimliği (örn: 1 = Ethereum Mainnet, 56 = BSC)
namestringToken'ın adı
descriptionstringToken hakkında açıklama
symbolstringToken sembolü (örn: BTC, ETH, USDT)
valuefloat64Token'ın değeri
supplyintToken'ın toplam arzı (supply)
external_idstringHarici sistemdeki token kimliği
contractTokenContractToken contract bilgileri
rulesTokenRulesToken kuralları (satın alma limitleri)
statusintToken durumu (1: Pending, 2: Listed, 3: Rejected, vb.)
integrationTokenIntegrationHarici entegrasyon bilgileri
metaTokenMetaToken metadata (görseller, dokümanlar)
created_attime.TimeToken'ın oluşturulma tarihi
updated_attime.TimeToken'ın son güncellenme tarihi
deleted_at*time.TimeToken'ın silinme tarihi (soft delete, opsiyonel)

TokenContract

Token contract bilgilerini temsil eder.

Alanlar

AlanTipAçıklama
addressstringToken contract adresi (blockchain adresi)
hashstringContract hash değeri

Örnek

{
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"hash": "0x1234567890abcdef1234567890abcdef12345678"
}

TokenRules

Token için satın alma kurallarını temsil eder.

Alanlar

AlanTipAçıklama
max_purchase_limitintMaksimum satın alma limiti
min_purchase_limitintMinimum satın alma limiti

Örnek

{
"max_purchase_limit": 10000,
"min_purchase_limit": 100
}

TokenIntegration

Harici entegrasyon sistemleri için token entegrasyon parametrelerini temsil eder.

Alanlar

AlanTipAçıklama
chain_idintBlockchain ağ kimliği
abistringContract ABI (Application Binary Interface)
contract_addressstringEntegrasyon contract adresi
function_namestringÇağrılacak fonksiyon adı
currency_token_addressstringÖdeme için kullanılan currency token adresi
is_approvedboolToken'ın onay durumu
argsTokenIntegrationArgsEntegrasyon fonksiyonu için argümanlar

Örnek

{
"chain_id": 1,
"abi": "[{\"type\":\"function\",\"name\":\"mint\",\"inputs\":[...]}]",
"contract_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"function_name": "mint",
"currency_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"is_approved": true,
"args": [
{
"type": "address",
"value": "0x123...",
"description": "Recipient address"
}
]
}

TokenIntegrationArg

Entegrasyon fonksiyonu için argüman bilgilerini temsil eder.

Alanlar

AlanTipAçıklama
typestringArgüman tipi (örn: address, uint256, string)
valuestringArgüman değeri
descriptionstringArgüman açıklaması

TokenMeta

Token metadata bilgilerini temsil eder (görseller ve dokümanlar).

Alanlar

AlanTipAçıklama
images[]ImageToken ile ilişkili görseller
documents[]DocumentToken ile ilişkili dokümanlar

Image

Token görsel bilgilerini temsil eder.

Alanlar

AlanTipAçıklama
idstringGörselin benzersiz kimliği
urlstringGörselin URL adresi
is_defaultboolVarsayılan görsel olup olmadığı
hashstringGörsel hash değeri
created_attime.TimeOluşturulma tarihi
deleted_at*time.TimeSilinme tarihi (opsiyonel)

Document

Token doküman bilgilerini temsil eder.

Alanlar

AlanTipAçıklama
idstringDokümanın benzersiz kimliği
namestringDoküman adı
urlstringDokümanın URL adresi
typeDocumentTypeDoküman tipi (1-9 arası değer)
hashstringDoküman hash değeri
created_attime.TimeOluşturulma tarihi
deleted_at*time.TimeSilinme tarihi (opsiyonel)

DocumentType Değerleri

DeğerTipAçıklama
1StandardStandart doküman
2WhitepaperWhitepaper dokümanı
3TermsOfServiceKullanım şartları
4PrivacyPolicyGizlilik politikası
5LegalAgreementYasal anlaşma
6ProspectusProspektüs
7AuditReportDenetim raporu
8LicenseLisans belgesi
9CertificateSertifika

CurrencyToken

Ödeme için kullanılan currency token bilgilerini temsil eder.

Alanlar

AlanTipAçıklama
idstringCurrency token'ın benzersiz kimliği
namestringCurrency token adı (örn: USD Coin)
symbolstringCurrency token sembolü (örn: USDC)
decimalsintCurrency token ondalık basamak sayısı
addressstringCurrency token contract adresi
chain_idintBlockchain ağ kimliği

Örnek

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "USD Coin",
"symbol": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"chain_id": 1
}

Tam Token Örneği

Aşağıda, tüm alanları içeren eksiksiz bir token yanıt örneği bulunmaktadır:

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"node_id": "550e8400-e29b-41d4-a716-446655440001",
"node": {
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Example Node",
"status": 1
},
"distributor_id": "550e8400-e29b-41d4-a716-446655440002",
"currency_token_id": "550e8400-e29b-41d4-a716-446655440003",
"currency_token": {
"id": "550e8400-e29b-41d4-a716-446655440003",
"name": "USD Coin",
"symbol": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"chain_id": 1
},
"chain_id": 1,
"name": "My Token",
"description": "This is an example token with comprehensive metadata",
"symbol": "MTK",
"value": 1.5,
"supply": 1000000,
"external_id": "EXT-12345",
"contract": {
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"hash": "0x1234567890abcdef1234567890abcdef12345678"
},
"rules": {
"max_purchase_limit": 10000,
"min_purchase_limit": 100
},
"status": 2,
"integration": {
"chain_id": 1,
"abi": "[{\"type\":\"function\",\"name\":\"mint\",\"inputs\":[{\"name\":\"to\",\"type\":\"address\"},{\"name\":\"amount\",\"type\":\"uint256\"}]}]",
"contract_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"function_name": "mint",
"currency_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"is_approved": true,
"args": [
{
"type": "address",
"value": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"description": "Recipient address for token minting"
},
{
"type": "uint256",
"value": "1000000000000000000",
"description": "Amount to mint in wei"
}
]
},
"meta": {
"images": [
{
"id": "550e8400-e29b-41d4-a716-446655440004",
"url": "https://example.com/images/token-logo.png",
"is_default": true,
"hash": "abc123def456",
"created_at": "2024-01-01T00:00:00Z",
"deleted_at": null
},
{
"id": "550e8400-e29b-41d4-a716-446655440005",
"url": "https://example.com/images/token-banner.png",
"is_default": false,
"hash": "def456ghi789",
"created_at": "2024-01-01T00:00:00Z",
"deleted_at": null
}
],
"documents": [
{
"id": "550e8400-e29b-41d4-a716-446655440006",
"name": "Token Whitepaper",
"url": "https://example.com/documents/whitepaper.pdf",
"type": 2,
"hash": "whitepaper123",
"created_at": "2024-01-01T00:00:00Z",
"deleted_at": null
},
{
"id": "550e8400-e29b-41d4-a716-446655440007",
"name": "Terms of Service",
"url": "https://example.com/documents/terms.pdf",
"type": 3,
"hash": "terms456",
"created_at": "2024-01-01T00:00:00Z",
"deleted_at": null
}
]
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"deleted_at": null
}

Token Durumları (Status)

Token durumları aşağıdaki gibidir:

DeğerDurumAçıklama
1Pending ApprovalOnay bekliyor
2ListedListelenmiş (aktif)
3RejectedReddedilmiş
4DelistedListeden çıkarılmış

Webhook Token Formatı

Webhook'larda gönderilen token formatı (TokenWebhook) temel olarak TokenResponse ile aynıdır, ancak node ve currency_token gibi nested objeler yerine sadece ID'ler gönderilir:

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"currency_token_id": "550e8400-e29b-41d4-a716-446655440003",
"chain_id": 1,
"node_id": "550e8400-e29b-41d4-a716-446655440001",
"distributor_id": "550e8400-e29b-41d4-a716-446655440002",
"name": "My Token",
"symbol": "MTK",
"description": "Token description",
"value": 1.5,
"supply": 1000000,
"external_id": "EXT-12345",
"contract": {
"address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"hash": "0x1234567890abcdef1234567890abcdef12345678"
},
"rules": {
"max_purchase_limit": 10000,
"min_purchase_limit": 100
},
"status": 2,
"integration": {
"chain_id": 1,
"abi": "[...]",
"contract_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"function_name": "mint",
"currency_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"is_approved": true,
"args": []
},
"meta": {
"images": [],
"documents": []
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}