https://github.com/sergeant61/parasut-api-v4

Paraşüt Api V4
https://github.com/sergeant61/parasut-api-v4

parasut parasutapi parasutapiv4

Last synced: 4 days ago
JSON representation

Paraşüt Api V4

• Host: GitHub
• URL: https://github.com/sergeant61/parasut-api-v4
• Owner: Sergeant61
• Created: 2024-01-06T17:28:30.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-02T09:58:15.000Z (10 months ago)
• Last Synced: 2024-10-29T20:02:36.713Z (16 days ago)
• Topics: parasut, parasutapi, parasutapiv4
• Language: TypeScript
• Homepage: https://apidocs.parasut.com/
• Size: 14.6 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Paraşüt-Api-V4

### Install

```

npm i parasut-api-v4

```

### Giriş

Bu npm modülün amacı https://apidocs.parasut.com/ da belirtilen api için bir sdk görevi görmektir. Resmi bir yayın değildir.

### Özellikler

1. Obje şeması üzerinden istekleri gönderebilme ör: `parasutApiV4.accounts.index({ queryParams, data, pagination })`

2. Request ve Response tiplerinin tanımlanması (kısmen mevcut)

3. Authorization yönetimi otomatik yapılıyor. Token süresi dolduğunda `refreshToken` isteği yapılmakta ve istek kaldığı yerden devam etmektedir.

### Kullanım örnekleri

```ts

import ParasutApiV4 from 'parasut-api-v4'

const run = async () => {

  const parasutApiV4 = new ParasutApiV4({

    firmaNo: '101010',

    email: 'ö[email protected]',

    password: '11111111111',

    clientId: '11111111111',

    clientSecret: '11111111111',

  })

  const meResult = await parasutApiV4.me()

  console.log(meResult.data)

}

run()

```

#### QueryParams, Pagination tanımlamaları

```ts

import ParasutApiV4 from 'parasut-api-v4'

const run = async () => {

  const parasutApiV4 = new ParasutApiV4({

    firmaNo: '101010',

    email: 'ö[email protected]',

    password: '11111111111',

    clientId: '11111111111',

    clientSecret: '11111111111',

  })

  const queryParams = { // obje şeklinde tanımlanır

    sort: '-balance',

  }

  const pagination = { // obje şeklinde tanımlanır

    limit: 1,

    size: 15,

  }

  const accountIndexResult = await parasutApiV4.accounts.index({ queryParams, pagination })

  console.log(accountIndexResult.data)

}

run()

```

### Hatalar ve İstekler

Kullanım sırasında yaşadığınız sorunları veya isteklerinizi https://github.com/Sergeant61/parasut-api-v4/issues iş kaydı açabilir veya https://recepozen.com 'dan bildirebilirsiniz.

### Destek olmak isteyenler

Mevcut kod yapısına uygun her türlü pr tarafımca kabul edilecektir.