Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

Changelly Fiat API SDK untuk TypeScript dan Javascript

SDK ini memungkinkan Anda bekerja dengan Changelly Fiat API dalam JavaScript dan TypeScript. Pengembang JavaScript akan menemukan perpustakaan berfitur lengkap dengan fungsi mudah untuk mengotomatisasi semua pemanggilan metode dalam API fiat Changelly; pengembang yang menggunakan TypeScript akan menemukan definisi yang kaya tentang tipe ketat.

Menggunakan SDK ini

  1. Daftar di website Changelly jika Anda belum memiliki akun.
  2. Kirimkan pesan kepada kami di [email protected] untuk mendapatkan kunci API. Tunjukkan email yang Anda gunakan untuk pendaftaran di situs Changelly.

Catatan. Jika Anda memiliki pertanyaan tentang integrasi SDK, jangan ragu untuk menghubungi kami di [email protected].

Tutorial ini akan memandu Anda memahami dasar-dasar pembuatan proyek yang menggunakan SDK API Changelly Fiat.

  1. Pertama, jalankan perintah berikut untuk membuat file package.json default: 
 > npm init --y
  1. Jika Anda memilih untuk menggunakan TypeScript, kini Anda dapat menambahkan fitur TypeScript ke proyek ini. Langkah-langkah berikut akan menginstal TypeScript, membuat file tsconfig.json , dan mendapatkan akses ke sebagian besar tipe bawaan untuk NodeJS: 
 > npm install typescript
> npx tsc --init
> npm install -D @types/node
  1. Tambahkan SDK API Changelly Fiat ke proyek Anda melalui Node Package Manager: 
 > npm install @changelly/fiat-api-sdk-node
  1. Setel kunci API Anda ke variabel lingkungan seperti CHANGELLY_PRIVATE_KEY dan CHANGELLY_PUBLIC_KEY sehingga tidak akan dikomit ke kontrol sumber.
  2. Buat file index.ts dasar untuk proyek Anda yang membuat klien API Changelly Fiat: 
 import { ChangellyFiatClient } from "@changelly/fiat-api-sdk-node" ;

const client = new ChangellyFiatClient ( {
  privateKey : process . env [ "CHANGELLY_PRIVATE_KEY" ] ,
  publicKey : process . env [ "CHANGELLY_PUBLIC_KEY" ] ,
} ) ;
  1. Lakukan panggilan API dan periksa hasilnya: 
 const providers = await client . getProviderList ( ) ;
const currencies = await client . getCurrencyList ( ) ;

console . log ( { providers , currencies } ) ;
  1. Untuk informasi lebih lanjut, lihat dokumentasi.

Referensi API

Klien Fiat yang Berubah

Kelas SDK Changelly Fiat API Node.js.

Konstruktor

Buat instans ChangellyFiatClient. 

 new ChangellyFiatClient (
  params : ChangellyFiatClientParams
) : ChangellyFiatClient

Parameter

  • params : ChangellyFiatClientParams

Mengembalikan ChangellyFiatClient

Metode

  • buildSignature
  • validasiOrderCallbackSignature
  • dapatkanDaftar Penyedia
  • dapatkanDaftar Mata Uang
  • getCountryAvailabilityList
  • dapatkan Penawaran
  • buatPesanan
  • validasiWalletAddress

buildSignature

Bangun X-Api-Signature. 

 buildSignature (
  params : ChangellyBuildSignatureParams
) : string ;

Parameter

  • params : ChangellyBuildSignatureParams

Mengembalikan string — Changelly X-Api-Signature

validasiOrderCallbackSignature

Validasi pesanan X-Callback-Signature. 

 validateOrderCallbackSignature (
  signature : string ,
  orderId : string
) : boolean ;

Parameter

  • tanda tangan : string — String berseri dengan orderId yang ditandatangani dengan kunci pribadi Changelly sesuai dengan metode RSA-SHA256.
  • orderId : string — Pengidentifikasi pesanan yang berubah-ubah.

Mengembalikan boolean — Apakah tanda tangan panggilan balik valid?

dapatkanDaftar Penyedia

Dapatkan informasi lebih lanjut tentang penyedia On-Ramp kepada pengguna. 

 getProviderList (
  config ?: AxiosRequestConfig
) : Promise < ChangellyGetProviderListResponse [ ] > ;

Parameter

  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyGetProviderListResponse[]>

dapatkanDaftar Mata Uang

Dapatkan daftar kripto dan mata uang fiat yang didukung. 

 getCurrencyList (
  params ?: ChangellyGetCurrencyListParams ,
  config ?: AxiosRequestConfig
) : Promise < ChangellyGetCurrencyListResponse [ ] > ;

Parameter

  • (opsional) parameter : ChangellyGetCurrencyListParams
  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyGetCurrencyListResponse[]>

getCountryAvailabilityList

Dapatkan daftar negara yang mendukung pembelian kripto. 

 getCountryAvailabilityList (
  params ?: ChangellyGetCountryAvailabilityParams ,
  config ?: AxiosRequestConfig
) : Promise < ChangellyGetCountryAvailabilityResponse [ ] > ;

Parameter

  • (opsional) parameter : ChangellyGetCountryAvailabilityParams
  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyGetCountryAvailabilityResponse[]>

dapatkan Penawaran

Dapatkan daftar penawaran pembelian dari penyedia On-Ramp. 

 getOffers (
  params : ChangellyGetOffersParams ,
  config ?: AxiosRequestConfig
) : Promise < ChangellyGetOffersResponse [ ] > ;

Parameter

  • params : ChangellyGetOffersParams
  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyGetOffersResponse[]>

buatPesanan

Buat pesanan pembelian kripto dan dapatkan URL pengalihan ke halaman pembelian. Jika salah satu parameter opsional tidak disediakan dalam permintaan, parameter tersebut akan dikembalikan dengan nilai "null" dalam respons. 

 createOrder (
  data : ChangellyCreateOrderParams ,
  config ?: AxiosRequestConfig
) : Promise < ChangellyCreateOrderResponse > ;

Parameter

  • data : ChangellyCreateOrderParams
  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyCreateOrderResponse[]>

validasiWalletAddress

Periksa apakah alamat dompet yang diberikan dan ID tambahan (opsional) valid untuk mata uang yang ditentukan. 

 validateWalletAddress (
  data : ChangellyValidateWalletAddressParams ,
  config ?: AxiosRequestConfig
) : Promise < ChangellyValidateWalletAddressResponse > ;

Parameter

  • data : ChangellyValidateWalletAddressParams
  • (opsional) konfigurasi : AxiosRequestConfig

Mengembalikan Janji<ChangellyValidateWalletAddressResponse[]>

Jenis

  • UbahllyFiatClientParams
  • ChangellyBuildSignatureParams
  • ChangellyGetProviderListResponse
  • ChangellyGetCurrencyListParams
  • ChangellyGetCurrencyListResponse
  • ChangellyGetCountryAvailabilityParams
  • ChangellyGetCountryAvailabilityResponse
  • ChangellyGetOffersParams
  • ChangellyGetOffersResponse
    • Penawaran berhasil
    • Tawaran gagal
  • ChangellyCreateOrderParams
  • ChangellyCreateOrderResponse
  • ChangellyValidateWalletAddressParams
  • ChangellyValidateWalletAddressResponse
  • Negara Berubah
  • Penawaran Metode Pembayaran Changelly
  • Detail ChangellyError

UbahllyFiatClientParams 

 interface ChangellyFiatClientParams {
  publicKey : string ;
  privateKey : string ;
  callbackPublicKey ?: string ;
  baseUrl ?: string ;
}

Properti

kunci publik

rangkaian

Kunci publik Changelly Fiat API.

kunci pribadi

rangkaian

Kunci pribadi Changelly Fiat API.

panggilan balikPublicKey

rangkaian

(opsional) Kunci publik panggilan balik API Changelly Fiat.

baseUrl

rangkaian

(opsional) Url dasar Changelly Fiat API. https://fiat-api.changelly.com/v1 secara default.

ChangellyBuildSignatureParams 

 interface ChangellyBuildSignatureParams {
  baseUrl ?: string ;
  pathname : ChangellyRequestUrl | string ;
  params ?:
    | ChangellyGetCurrencyListParams
    | ChangellyGetCountryAvailabilityParams
    | ChangellyGetOffersParams ;
  data ?: ChangellyCreateOrderParams | ChangellyValidateWalletAddressParams ;
}

Properti

baseUrl

rangkaian

(opsional) Url dasar. https://fiat-api.changelly.com/v1 secara default.

nama jalan

ChangellyRequestUrl | rangkaian

Minta alamat.

param

ChangellyGetCurrencyListParams | ChangellyGetCountryAvailabilityParams | ChangellyGetOffersParams

(opsional) Minta parameter kueri.

data

ChangellyCreateOrderParams | ChangellyValidateWalletAddressParams

(opsional) Minta parameter isi.

ChangellyGetProviderListResponse 

 interface ChangellyGetProviderListResponse {
  code : ChangellyProvider ;
  name : string ;
  trustPilotRating : string ;
  iconUrl : string ;
}

Properti

kode

Penyedia Changelly

Kode penyedia On-Ramp.

nama

rangkaian

Nama penyedia On-Ramp.

kepercayaanPilotRating

rangkaian

Peringkat penyedia di Trustpilot.

ikonUrl

rangkaian

URL ikon penyedia On-Ramp.

ChangellyGetCurrencyListParams 

 interface ChangellyGetCurrencyListParams {
  type ?: ChangellyCurrency ;
  providerCode ?: ChangellyProvider ;
}

Properti

jenis

Mata Uang Berubah

(opsional) Jenis mata uang. Jika jenis mata uang tidak ditentukan, titik akhir akan mengembalikan mata uang fiat dan mata uang kripto.

kode penyedia

Penyedia Changelly

(opsional) Penyedia yang mata uangnya ingin Anda lihat. Jika kode penyedia On-Ramp tidak ditentukan, titik akhir akan mengembalikan mata uang yang didukung semua penyedia.

ChangellyGetCurrencyListResponse 

 interface ChangellyGetCurrencyListResponse {
  ticker : string ;
  name : string ;
  type : ChangellyCurrency ;
  extraIdName : string | null ;
  iconUrl : string ;
  precision : string ;
}

Properti

jantung

rangkaian

Penanda mata uang dalam huruf besar. Ini adalah pengidentifikasi unik mata uang.

nama

rangkaian

Nama mata uang yang dapat Anda tentukan di antarmuka Anda.

jenis

Mata Uang Berubah

Jenis mata uang.

ekstraIdName

tali | batal

Nama ID tambahan dari mata uang kripto, misalnya, "Memo". Diperlukan untuk mata uang berikut: XRP, XLM, EOS, BNB. Untuk mata uang fiat dan mata uang kripto tanpa ID tambahan, extraIdName sama dengan null. Jika mata uang memiliki ID tambahan, Anda perlu memberikan parameter walletExtraId dalam permintaan ke titik akhir /v1/orders dan /v1/validate-address .

ikonUrl

rangkaian

URL ikon mata uang.

presisi

rangkaian

Ketepatan mata uang. Untuk mata uang fiat, selalu sama dengan 2.

ChangellyGetCountryAvailabilityParams 

 interface ChangellyGetCountryAvailabilityParams {
  providerCode ?: ChangellyProvider ;
}

Properti

(opsional) kode penyedia

Penyedia Changelly

(opsional) Penyedia negara yang ingin Anda lihat. Jika kode penyedia On-Ramp tidak ditentukan, titik akhir akan mengembalikan negara yang didukung dari semua penyedia.

ChangellyGetCountryAvailabilityResponse 

 interface ChangellyGetCountryAvailabilityResponse {
  code : ChangellyProvider ;
  name : string ;
  states ?: ChangellyState [ ] ;
}

Properti

kode

Penyedia Changelly

Kode penyedia On-Ramp.

nama

rangkaian

Nama penyedia On-Ramp.

negara bagian

Negara Berubah []

(opsional) negara bagian AS. Dikembalikan jika kode negaranya adalah AS.

ChangellyGetOffersParams 

 interface ChangellyGetOffersParams {
  providerCode ?: ChangellyProvider ;
  externalUserId ?: string ;
  currencyFrom : string ;
  currencyTo : string ;
  amountFrom : string ;
  country : string ;
  state ?: string ;
  ip ?: string ;
}

Properti

kode penyedia

Penyedia Changelly

(opsional) Kode penyedia On-Ramp.

IdPengguna eksternal

rangkaian

(opsional) ID Pengguna yang Anda berikan.

mata uangDari

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

mata uangKe

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

jumlahDari

rangkaian

Jumlah mata uang yang akan dibayar pengguna.

negara

rangkaian

Kode ISO 3166-1 negara (Alpha-2).

negara

rangkaian

(opsional) Sebutkan kode ISO 3166-2. Diperlukan jika negara yang disediakan adalah AS.

aku p

rangkaian

(opsional) Alamat IP pengguna.

ChangellyGetOffersResponse

Bisa sukses dan gagal.

Penawaran berhasil 

 interface Offer {
  providerCode : ChangellyProvider ;
  rate : string ;
  invertedRate : string ;
  fee : string ;
  amountFrom : string ;
  amountExpectedTo : string ;
  paymentMethodOffers : ChangellyPaymentMethodOffer [ ] ;
}

Properti

kode penyedia

Penyedia Changelly

Kode penyedia On-Ramp.

kecepatan

rangkaian

Tingkat pembelian terbaik di antara semua metode pembayaran. Tarif sudah termasuk semua biaya.

Tingkat terbalik

rangkaian

Tingkat pembelian terbalik.

biaya

rangkaian

Nilai total biaya pembelian terendah di antara semua metode pembayaran.

jumlahDari

rangkaian

Jumlah mata uang yang akan dibayar pengguna.

jumlah yang diharapkan

rangkaian

Jumlah dana terbesar di antara semua metode pembayaran yang diharapkan diterima pengguna setelah pembelian.

Metode pembayaranPenawaran

ChangellyPaymentMethodPenawaran []

Detail pembelian untuk setiap jenis pembayaran yang tersedia. Metode pembayaran selain "kartu" akan tersedia nanti.

Tawaran gagal 

 interface Offer {
  providerCode : ChangellyProvider ;
  errorType :
    | ChangellyErrorType . Timeout
    | ChangellyErrorType . Unavailable
    | ChangellyErrorType . Limits
    | ChangellyErrorType . Country
    | ChangellyErrorType . State
    | ChangellyErrorType . Currency
    | ChangellyErrorType . PaymentMethod
    | ChangellyErrorType . InvalidOffer ;
  errorMessage : string ;
  errorDetails : ChangellyErrorDetails [ ] | null ;
}

Properti

kode penyedia

Penyedia Changelly

Kode penyedia On-Ramp.

tipe kesalahan

ChangellyErrorType (Batas Waktu, Tidak Tersedia, Batas, Negara, Negara Bagian, Mata Uang, Metode Pembayaran, Penawaran Tidak Valid)

Jenis kesalahan.

pesan kesalahan

rangkaian

Pesan kesalahan.

detail kesalahan

ChangellyErrorDetail [] | batal

Detail kesalahan. Jika kesalahan tidak berisi detail, errorDetails sama dengan nol.

ChangellyCreateOrderParams 

 type ChangellyCreateOrderParams = {
  externalOrderId : string ;
  externalUserId : string ;
  providerCode : ChangellyProvider ;
  currencyFrom : string ;
  currencyTo : string ;
  amountFrom : string ;
  country : string ;
  state ?: string ;
  ip ?: string ;
  walletAddress : string ;
  walletExtraId ?: string ;
  paymentMethod ?: ChangellyPaymentMethod ;
  userAgent ?: string ;
  metadata ?: Record < string , unknown > ;
} ;

Properti

IdPesanan eksternal

rangkaian

ID Pesanan yang Anda berikan.

IdPengguna eksternal

rangkaian

ID Pengguna yang Anda berikan.

kode penyedia

Penyedia Changelly

Kode penyedia On-Ramp.

mata uangDari

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

mata uangKe

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

jumlahDari

rangkaian

Jumlah mata uang yang akan dibayar pengguna.

negara

rangkaian

Kode ISO 3166-1 negara (Alpha-2).

negara

rangkaian

(opsional) Sebutkan kode ISO 3166-2. Diperlukan jika negara yang disediakan adalah AS.

aku p

rangkaian

(opsional) Alamat IP pengguna.

alamat dompet

rangkaian

Alamat dompet penerima. Berikut adalah 2 kasus penggunaan sederhana dari parameter ini:

  • Jika Anda ingin menyediakan layanan pembelian mata uang kripto, Anda harus mengizinkan pengguna untuk menentukan alamat dompet.
  • Jika Anda ingin menjual produk Anda dengan harga fiat dan menerima mata uang kripto di dompet Anda, Anda harus menentukan alamat dompet Anda sendiri.

dompetExtraId

rangkaian

(opsional) Properti diperlukan untuk alamat dompet mata uang yang menggunakan ID tambahan untuk pemrosesan transaksi (XRP, XLM, EOS, BNB).

Metode pembayaran

Metode Pembayaran Changelly

(opsional) Kode metode pembayaran.

agen pengguna

rangkaian

(opsional) Agen Pengguna.

metadata

Rekam<string, tidak diketahui>

(opsional) Objek metadata, yang dapat berisi parameter apa pun yang Anda perlukan.

ChangellyCreateOrderResponse 

 interface ChangellyCreateOrderResponse {
  redirectUrl : string ;
  orderId : string ;
  externalUserId : string ;
  externalOrderId : string ;
  providerCode : ChangellyProvider ;
  currencyFrom : string ;
  currencyTo : string ;
  amountFrom : string ;
  country : string ;
  state : string | null ;
  ip : string | null ;
  walletAddress : string ;
  walletExtraId : string | null ;
  paymentMethod : ChangellyPaymentMethod | null ;
  userAgent : string | null ;
  metadata : Record < string , unknown > | null ;
  createdAt : string ;
}

Properti

redirectUrl

rangkaian

URL ke halaman pembelian penyedia.

ID pesanan

rangkaian

ID pesanan internal disediakan oleh Fiat API.

IdPengguna eksternal

rangkaian

ID Pengguna yang Anda berikan.

IdPesanan eksternal

rangkaian

ID Pesanan yang Anda berikan.

kode penyedia

Penyedia Changelly

Kode penyedia On-Ramp.

mata uangDari

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

mata uangKe

rangkaian

Ticker mata uang pembayaran dalam huruf besar.

jumlahDari

rangkaian

Jumlah mata uang yang akan dibayar pengguna.

negara

rangkaian

Kode ISO 3166-1 negara (Alpha-2).

negara

tali | batal

Sebutkan kode ISO 3166-2. Akan bernilai null jika negara yang diberikan bukan AS.

aku p

tali | batal

Alamat IP pengguna.

alamat dompet

rangkaian

Alamat dompet penerima.

dompetExtraId

tali | batal

Properti yang diperlukan untuk alamat dompet mata uang yang menggunakan ID tambahan untuk pemrosesan transaksi (XRP, XLM, EOS, BNB).

Metode pembayaran

Metode Pembayaran Changelly | batal

Kode metode pembayaran.

agen pengguna

tali | batal

Agen Pengguna.

metadata

Rekam<string, tidak diketahui> | batal

Objek metadata, yang dapat berisi parameter apa pun yang Anda perlukan. Jika Anda tidak memberikan objek metadata dalam permintaan, null akan dikembalikan dalam metadata sebagai respons. Jika Anda menentukan objek kosong dalam permintaan, objek kosong akan dikembalikan sebagai respons.

dibuatPada

rangkaian

Waktu dalam format ISO 8601.

ChangellyValidateWalletAddressParams 

 interface ChangellyValidateWalletAddressParams {
  currency : string ;
  walletAddress : string ;
  walletExtraId ?: string ;
}

Properti

mata uang

rangkaian

Ticker mata uang kripto dalam huruf besar.

alamat dompet

rangkaian

Alamat dompet penerima.

dompetExtraId

rangkaian

(opsional) Properti diperlukan untuk alamat dompet mata uang yang menggunakan ID tambahan untuk pemrosesan transaksi (XRP, XLM, EOS, BNB).

ChangellyValidateWalletAddressResponse 

 interface ChangellyValidateWalletAddressResponse {
  result : boolean ;
  cause : "walletAddress" | "walletExtraId" | null ;
}

Properti

hasil

boolean

Salah jika alamat dompet atau ID tambahan salah.

menyebabkan

"alamat dompet" | "dompetExtraId" | batal

Menentukan apakah alamat dompet atau ID tambahan salah. Jika hasilnya benar, sebab sama dengan nol.

Negara Berubah 

 interface ChangellyState {
  code : string ;
  name : string ;
}

Properti

kode

rangkaian

Sebutkan kode ISO 3166-2.

nama

rangkaian

Nama negara bagian.

Penawaran Metode Pembayaran Changelly 

 interface ChangellyPaymentMethodOffer {
  amountExpectedTo : string ;
  method : ChangellyPaymentMethod ;
  methodName : string ;
  invertedRate : string ;
  fee : string ;
}

Properti

jumlah yang diharapkan

rangkaian

Jumlah dana yang diharapkan diperoleh pengguna setelah pembelian.

metode

Metode Pembayaran Changelly

Kode metode pembayaran.

nama metode

rangkaian

Nama metode pembayaran.

Tingkat terbalik

rangkaian

Tingkat pembelian saat ini, yang mencakup semua biaya.

biaya

rangkaian

Total biaya pembelian.

Detail ChangellyError 

 interface ChangellyErrorDetails {
  cause : string ;
  value : string ;
}

Properti

menyebabkan

rangkaian

Penyebab kesalahan. Misalnya, ini bisa sama dengan parameter permintaan yang hilang untuk jenis kesalahan validasi.

nilai

rangkaian

Nilai kesalahan.

Pencacahan

  • ChangellyRequestUrl
  • Penyedia Changelly
  • Mata Uang Berubah
  • ChangellyErrorType
  • Metode Pembayaran Changelly

ChangellyRequestUrl 

 enum ChangellyRequestUrl {
  ProvderList = "/v1/providers" ,
  CurrencyList = "/v1/currencies" ,
  CountryAvailability = "/v1/available-countries" ,
  GetOffers = "/v1/offers" ,
  CreateOrder = "/v1/orders" ,
  ValidateWalletAddress = "/v1/validate-address" ,
}

Anggota

  • Daftar Penyedia : "/v1/penyedia"
  • Daftar Mata Uang : "/v1/mata uang"
  • Ketersediaan Negara : "/v1/negara-tersedia"
  • Dapatkan Penawaran : "/v1/penawaran"
  • BuatPesanan : "/v1/pesanan"
  • ValidateWalletAddress : "/v1/validate-address"

Penyedia Changelly 

 enum ChangellyProvider {
  Moonpay = "moonpay" ,
  Banxa = "banxa" ,
  Wert = "wert" ,
}

Anggota

  • Pembayaran bulan : "pembayaran bulan"
  • Banxa : "banxa"
  • Wert : "wert"

Mata Uang Berubah 

 enum ChangellyCurrency {
  Crypto = "crypto" ,
  Fiat = "fiat"
Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua